Module: BiDiGenerate Private

Defined in:: lib/selenium/webdriver/bidi/support/bidi_generate.rb,
lib/selenium/webdriver/bidi/support/check_generated.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Generates Ruby WebDriver BiDi protocol modules from the shared, binding-neutral BiDi schema produced by the JavaScript generator (see PR #17700):

//javascript/selenium-webdriver:create-bidi-src_schema -> bidi-schema.json

The schema is already normalized (inline enums hoisted, unions canonicalized, group composition flattened, wire names and nullability preserved verbatim), so this generator is a straight projection into Ruby with no CDDL interpretation.

Invoked via bazel run //rb/lib/selenium/webdriver:bidi-generate. Bazel passes the schema path (resolved through runfiles) plus the workspace-relative output directory as ARGV, and supplies the shared generated-note text as a runfile, so this is not runnable directly from a source checkout.

Defined Under Namespace

Classes: Accessor, Command, Enum, ErrorModule, Event, FieldIR, Module, Param, Schema, TypeClass, UnionClass, VariantIR, VendorCommand, VendorModule

Constant Summary collapse

BIDI_DOC_URL =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Companion to the generated @api private tags: the page explaining why the BiDi implementation layer is internal and what higher-level API to use instead (see #17628).

'https://www.selenium.dev/documentation/warnings/bidi-implementation/'

LINE_LIMIT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

RuboCop's Layout/LineLength max; emitted Serialization::Record.define calls wrap to stay within it.

RUBY_RESERVED =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Ruby keywords that cannot be used as method names unquoted.

%w[begin end rescue ensure raise return yield if unless while until for do
case when then class module def].freeze

RESERVED_FIELD_NAMES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Object/Data methods a Data member name would shadow (breaking value semantics or reflection), e.g. a "method" field overriding Object#method.

(RUBY_RESERVED + %w[method hash class send dup clone freeze inspect
to_h to_s members with deconstruct deconstruct_keys
object_id tap itself then display
extensible extensions]).freeze

RBS_VALUE_TYPES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

The RBS type a schema value primitive maps to; an unrecognized one is untyped.

{'string' => 'String', 'integer' => 'Integer', 'number' => 'Float',
'boolean' => 'bool'}.freeze

PARAMS_CLASS_KINDS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Param kinds the named args can construct a Parameters object for (record fields, or a union dispatched to one of its variants); anything else forwards a raw hash.

%w[record union].freeze

INHERITED_INSTANCE_METHODS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Public instance methods every accessor would shadow if it reused their name: Domain's own (execute/initialize) plus everything Object/Kernel expose. The collision guard fails generation before a schema-driven shadow can ship.

(%w[execute initialize].to_set + Object.instance_methods.to_set(&:to_s)).freeze