Class: RailroadDiagrams::Optional

Inherits:
Choice
  • Object
show all
Defined in:
lib/railroad_diagrams/optional.rb,
sig/generated/railroad_diagrams/optional.rbs

Overview

Draws an item with a bypass path.

Examples:

Optional.new('DISTINCT')

Direct Known Subclasses

ZeroOrMore

Instance Method Summary collapse

Methods inherited from Choice

#add_downward_path, #add_downward_return_path, #add_upward_path, #add_upward_return_path, #child_nodes, #choice_layout, #expand_text, #format, #format_default_item, #format_items_above_default, #format_items_below_default, #measure, #render_svg, #render_text, #svg_path, #text_diagram, #text_gaps, #to_s

Constructor Details

#initialize(item, legacy_skip = Deprecation::UNSET, skip: Deprecation::UNSET, id: nil, cls: nil, attrs: {}) ⇒ Optional

Returns a new instance of Optional.

Parameters:

  • item (DiagramItem, String)
  • legacy_skip (Object) (defaults to: Deprecation::UNSET)
  • skip: (Boolean) (defaults to: Deprecation::UNSET)
  • id: (Object) (defaults to: nil)
  • cls: (Object) (defaults to: nil)
  • attrs: (Object) (defaults to: {}) 


12
13
14
15
16
 
# File 'lib/railroad_diagrams/optional.rb', line 12

def initialize(item, legacy_skip = Deprecation::UNSET, skip: Deprecation::UNSET,
               id: nil, cls: nil, attrs: {})
  skip = Deprecation.positional_argument('skip', legacy_skip, skip, false)
  super(skip ? 0 : 1, Skip.new, item, id: id, cls: cls, attrs: attrs)
end