Class: Vedeu::Menus::DSL

Inherits:

Object

• Object
• Vedeu::Menus::DSL

Includes:

DSL

Defined in:

lib/vedeu/menus/dsl.rb

Overview

Provides the mechanism to create menus within client applications and use events to drive them.

Instance Attribute Summary

• #client ⇒ Object included from DSL readonly protected

  The object instance where the DSL is being used.

• #model ⇒ void included from DSL readonly protected

  The new model object which the DSL is constructing.

Class Method Summary

• .client(&block) ⇒ Object private

  Returns the client object which called the DSL method.

• .menu(name, &block) ⇒ API::Menu

  Register a menu by name which will display a collection of items for your users to select; and provide interactivity within your application.

Instance Method Summary

• #attributes ⇒ Hash<Symbol => void> included from DSL private

  Returns the default attributes for the new model.

• #initialize(model, client = nil) ⇒ void included from DSL

  Returns a new instance of the DSL class including DSL.

• #item(element) ⇒ Array (also: #item=)

  Add an individual item to the menu.

• #items(collection = []) ⇒ Array (also: #items=)

  Define the items for the menu.

• #method_missing(method, *args, &block) ⇒ void included from DSL private

  Attempts to find the missing method on the client object.

• #name ⇒ NilClass|String|Symbol included from DSL

  Returns the model name if available.

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Vedeu::DSL

Instance Attribute Details

#client ⇒ Object (readonly, protected) Originally defined in module DSL

Returns The object instance where the DSL is being used.

Returns:

• (Object) —

  The object instance where the DSL is being used.

#model ⇒ void (readonly, protected) Originally defined in module DSL

This method returns an undefined value.

Returns The new model object which the DSL is constructing.

Class Method Details

.client(&block) ⇒ Object (private)

Returns the client object which called the DSL method.

Parameters:

• block (Proc)

Returns:

• (Object)

# File 'lib/vedeu/menus/dsl.rb', line 55

def client(&block)
  eval('self', block.binding)
end

.menu(name, &block) ⇒ API::Menu

Register a menu by name which will display a collection of items for your users to select; and provide interactivity within your application.

Examples:

Vedeu.menu :my_interface do
  items [:item_1, :item_2, :item_3]
  # ...
end

Vedeu.menu do
  name :menus_must_have_a_name
  items Track.all_my_favourites
  # ...
end

Parameters:

• name (String|Symbol) —

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

• block (Proc) —

  A set of attributes which define the features of the menu.

Returns:

• (API::Menu)

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).

# File 'lib/vedeu/menus/dsl.rb', line 40

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

  attributes = { client: client(&block), name: name }

  Vedeu::Menus::Menu.build(attributes, &block).store
end

Instance Method Details

#attributes ⇒ Hash<Symbol => void> (private) Originally defined in module DSL

Note:

Specific DSL classes may be overriding this method.

Returns the default attributes for the new model.

Returns:

• (Hash<Symbol => void>)

#initialize(model, client = nil) ⇒ void Originally defined in module DSL

Returns a new instance of the DSL class including Vedeu::DSL.

Parameters:

• model (void) —

  The model class which the DSL class is wrapping.

• client (void) (defaults to: nil) —

  The class where the DSL methods are being used.

#item(element) ⇒ Array Also known as: item=

Add an individual item to the menu.

Parameters:

• element (Object) —

  An object you wish to add to the collection.

  Vedeu.menu :my_menu do

  item SomeClass.new
  item SomeClass.new
  

  end

Returns:

• (Array)

# File 'lib/vedeu/menus/dsl.rb', line 72

def item(element)
  model.collection << element
end

#items(collection = []) ⇒ Array Also known as: items=

Define the items for the menu. Most powerful when used with one of your model classes.

In the :my_playlist example below, your ‘Track` model may return a collection of tracks to populate the menu.

Vedeu.menu :my_menu do
  items [:item_1, :item_2, :item_3]
end

Vedeu.menu :my_playlist do
  items Track.all_my_favourites
end

Parameters:

• collection (Array<Object>) (defaults to: []) —

  A collection of objects which make up the menu items.

Returns:

• (Array)

# File 'lib/vedeu/menus/dsl.rb', line 94

def items(collection = [])
  model.collection = collection
end

#name ⇒ NilClass|String|Symbol Originally defined in module DSL

Returns the model name if available.

Returns:

• (NilClass|String|Symbol)