Class: CMDx::Inputs::ChildBuilder

Inherits:

Object

• Object
• CMDx::Inputs::ChildBuilder

Defined in:

lib/cmdx/inputs.rb

Overview

DSL receiver for the block passed to #register. Builds a frozen list of child CMDx::Inputs. Supports arbitrary nesting: every DSL method accepts its own block.

Instance Attribute Summary

• #children ⇒ Object readonly

  Returns the value of attribute children.

Class Method Summary

• .build { ... } ⇒ Array<Input>

  Frozen list of built children.

Instance Method Summary

• #initialize ⇒ ChildBuilder constructor

  A new instance of ChildBuilder.

• #inputs(*names, **options) { ... } ⇒ Array<Input> (also: #input)
• #optional(*names, **options) { ... } ⇒ Array<Input>

  Declares optional child inputs (equivalent to ‘inputs …, required: false`).

• #required(*names, **options) { ... } ⇒ Array<Input>

  Declares required child inputs (equivalent to ‘inputs …, required: true`).

Constructor Details

#initialize ⇒ ChildBuilder

Returns a new instance of ChildBuilder.

# File 'lib/cmdx/inputs.rb', line 125

def initialize
  @children = []
end

Instance Attribute Details

#children ⇒ Object (readonly)

Returns the value of attribute children.

# File 'lib/cmdx/inputs.rb', line 123

def children
  @children
end

Class Method Details

.build { ... } ⇒ Array<Input>

Returns frozen list of built children.

Yields:

• block evaluated in a CMDx::Inputs::ChildBuilder for nested inputs

Returns:

• (Array<Input>) —

  frozen list of built children

# File 'lib/cmdx/inputs.rb', line 115

def build(&)
  builder = new
  builder.instance_eval(&)
  builder.children.freeze
end

Instance Method Details

#inputs(*names, **options) { ... } ⇒ Array<Input> Also known as: input

Parameters:

• names (Array<Symbol>)
• options (Hash{Symbol => Object}) —

  forwarded to CMDx::Input#initialize

Options Hash (**options):

• :description (String) — default: also accepts `:desc`
• :as (Symbol) —

  overrides the accessor name

• :prefix (Boolean, String) —

  prefix for the accessor name

• :suffix (Boolean, String) —

  suffix for the accessor name

• :source (Symbol, Proc, #call) — default: `:context` —

  where to fetch from

• :default (Object, Symbol, Proc, #call)
• :transform (Symbol, Proc, #call) —

  mutator applied after coercion

• :if (Symbol, Proc, #call)
• :unless (Symbol, Proc, #call)
• :required (Boolean)
• :coerce (Object) —

  forwarded with declaration (see Coercions#extract)

• :validate (Object) —

  forwarded with declaration (see Validators#extract)

Yields:

• nested child input DSL

Returns:

• (Array<Input>)

# File 'lib/cmdx/inputs.rb', line 145

def inputs(*names, **options, &)
  build(*names, **options, &)
end

#optional(*names, **options) { ... } ⇒ Array<Input>

Declares optional child inputs (equivalent to ‘inputs …, required: false`). An explicit `required:` in `options` is ignored — use #inputs when you need to set the flag dynamically.

Parameters:

• names (Array<Symbol>)
• options (Hash{Symbol => Object}) —

  forwarded to CMDx::Input#initialize

Options Hash (**options):

• :description (String) — default: also accepts `:desc`
• :as (Symbol) —

  overrides the accessor name

• :prefix (Boolean, String) —

  prefix for the accessor name

• :suffix (Boolean, String) —

  suffix for the accessor name

• :source (Symbol, Proc, #call) — default: `:context` —

  where to fetch from

• :default (Object, Symbol, Proc, #call)
• :transform (Symbol, Proc, #call) —

  mutator applied after coercion

• :if (Symbol, Proc, #call)
• :unless (Symbol, Proc, #call)
• :coerce (Object) —

  forwarded with declaration (see Coercions#extract)

• :validate (Object) —

  forwarded with declaration (see Validators#extract)

Yields:

• nested child input DSL

Returns:

• (Array<Input>)

# File 'lib/cmdx/inputs.rb', line 169

def optional(*names, **options, &)
  build(*names, **options, required: false, &)
end

#required(*names, **options) { ... } ⇒ Array<Input>

Declares required child inputs (equivalent to ‘inputs …, required: true`). An explicit `required:` in `options` is ignored — use #inputs when you need to set the flag dynamically.

Parameters:

• names (Array<Symbol>)
• options (Hash{Symbol => Object}) —

  forwarded to CMDx::Input#initialize

Options Hash (**options):

• :description (String) — default: also accepts `:desc`
• :as (Symbol) —

  overrides the accessor name

• :prefix (Boolean, String) —

  prefix for the accessor name

• :suffix (Boolean, String) —

  suffix for the accessor name

• :source (Symbol, Proc, #call) — default: `:context` —

  where to fetch from

• :default (Object, Symbol, Proc, #call)
• :transform (Symbol, Proc, #call) —

  mutator applied after coercion

• :if (Symbol, Proc, #call)
• :unless (Symbol, Proc, #call)
• :coerce (Object) —

  forwarded with declaration (see Coercions#extract)

• :validate (Object) —

  forwarded with declaration (see Validators#extract)

Yields:

• nested child input DSL

Returns:

• (Array<Input>)

# File 'lib/cmdx/inputs.rb', line 192

def required(*names, **options, &)
  build(*names, **options, required: true, &)
end