Module: Vedeu::DSL::Border::ClassMethods

Defined in:

lib/vedeu/dsl/border.rb

Overview

When Vedeu::DSL::Border is included in a class, the methods within this module are included as class methods on that class.

Instance Method Summary

• #border(name, &block) ⇒ Vedeu::Borders::Border

  Specify the border of an interface or view with a simple DSL.

Instance Method Details

#border(name, &block) ⇒ Vedeu::Borders::Border

Specify the border of an interface or view with a simple DSL.

# Standalone (preferred):
Vedeu.border :my_interface do
  # ... see {Vedeu::Borders::DSL}
end

Parameters:

• name (String|Symbol) —

  The name of the interface or view to which this border belongs.

• block (Proc)

Returns:

• (Vedeu::Borders::Border)

Raises:

• (Vedeu::Error::RequiresBlock) —

  When the required block was not given.

• (Vedeu::Error::MissingRequired) —

  When the required argument or parameter was given but without a meaningful or usable value (e.g. nil).

See Also:

• Borders::DSL

# File 'lib/vedeu/dsl/border.rb', line 34

def border(name, &block)
  fail Vedeu::Error::MissingRequired unless name
  fail Vedeu::Error::RequiresBlock unless block_given?

  Vedeu::Borders::Border.build(enabled: true, name: name, &block).store
end