Class: Vedeu::Menu

Inherits:
Object
  • Object
show all
Includes:
Model
Defined in:
lib/vedeu/models/menu.rb

Overview

Converts the collection passed into a list of menu items which can be navigated using the instance methods or events provided.

Instance Attribute Summary collapse

Attributes included from Model

#repository

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Model

#demodulize, #deputy, #dsl_class, included, #store

Constructor Details

#initialize(attributes = {}) ⇒ Menu

Returns a new instance of Vedeu::Menu.

Parameters:

  • attributes (Hash) (defaults to: {})

Options Hash (attributes):

  • collection (Array)
  • name (String)
  • current (Fixnum)
  • selected (Fixnum|NilClass) 


65
66
67
68
69
70
71
 
# File 'lib/vedeu/models/menu.rb', line 65

def initialize(attributes = {})
  @attributes = defaults.merge!(attributes)

  @attributes.each do |key, value|
    instance_variable_set("@#{key}", value)
  end
end

Instance Attribute Details

#collection ⇒ Array

Returns:

  • (Array) 


11
12
13
 
# File 'lib/vedeu/models/menu.rb', line 11

def collection
  @collection
end

#current ⇒ Fixnum

Returns the index of the value in the collection which is current.

Returns:

  • (Fixnum) 


17
18
19
 
# File 'lib/vedeu/models/menu.rb', line 17

def current
  @current
end

#name ⇒ String

The name of the menu. Used to reference the menu throughout the application’s execution lifetime.

Returns:

  • (String) 


24
25
26
 
# File 'lib/vedeu/models/menu.rb', line 24

def name
  @name
end

#selected ⇒ Fixnum

Returns the index of the value in the collection which is selected.

Returns:

  • (Fixnum) 


30
31
32
 
# File 'lib/vedeu/models/menu.rb', line 30

def selected
  @selected
end

Class Method Details

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

Vedeu.menu do
  name 'menus_must_have_a_name'
  items Track.all_my_favourites
  ...

Parameters:

  • name (String) (defaults to: '')
  • block (Proc) —

    A set of attributes which define the features of the menu. See DSL::Menu#items and DSL::Menu#name.

Returns:

  • (API::Menu)

Raises:

  • (InvalidSyntax) —

    The required block was not given.



51
52
53
54
55
 
# File 'lib/vedeu/models/menu.rb', line 51

def self.menu(name = '', &block)
  fail InvalidSyntax, 'block not given' unless block_given?

  build({ name: name }, &block).store
end

Instance Method Details

#bottom_item ⇒ Array

Sets the value of current to be the last item of the collection.

Returns:

  • (Array) 


140
141
142
143
144
 
# File 'lib/vedeu/models/menu.rb', line 140

def bottom_item
  @current = last

  items
end

#current_item ⇒ void

This method returns an undefined value.

Returns the item from the collection which shares the same index as the value of #current.



77
78
79
 
# File 'lib/vedeu/models/menu.rb', line 77

def current_item
  @collection[@current]
end

#defaults ⇒ Hash (private)

The default values for a new instance of this class.

Returns:

  • (Hash) 


203
204
205
206
207
208
209
210
211
212
 
# File 'lib/vedeu/models/menu.rb', line 203

def defaults
  {
    client:     nil,
    collection: [],
    current:    0,
    name:       '',
    repository: Vedeu.menus,
    selected:   nil,
  }
end

#deselect_item ⇒ Array

Removes the value of ‘selected`, meaning no items are selected.

Returns:

  • (Array) 


178
179
180
181
182
 
# File 'lib/vedeu/models/menu.rb', line 178

def deselect_item
  @selected = nil

  items
end

#items ⇒ Array

Returns a new collection of items. Each element of the collection is of the format:

[selected, current, item]

‘selected` is a boolean indicating whether the item is selected. `current` is a boolean indicating whether the item is current. `item` is the item itself.

Returns:

  • (Array) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/vedeu/models/menu.rb', line 101

def items
  items = []
  @collection.each_with_index do |item, index|
    if index == @current && index == @selected
      items << [true, true, item]

    elsif index == @current
      items << [false, true, item]

    elsif index == @selected
      items << [true, false, item]

    else
      items << [false, false, item]

    end
  end
  items
end

#last ⇒ Fixnum

Returns the last index of the collection.

Returns:

  • (Fixnum) 


187
188
189
 
# File 'lib/vedeu/models/menu.rb', line 187

def last
  @collection.size - 1
end

#next_item ⇒ Array

Sets the value of current to be the next item in the collection until we reach the last.

Returns:

  • (Array) 


150
151
152
153
154
 
# File 'lib/vedeu/models/menu.rb', line 150

def next_item
  @current += 1 if @current < last

  items
end

#prev_item ⇒ Array

Sets the value of current to be the previous item in the collection until we reach the first.

Returns:

  • (Array) 


160
161
162
163
164
 
# File 'lib/vedeu/models/menu.rb', line 160

def prev_item
  @current -= 1 if @current > 0

  items
end

#select_item ⇒ Array

Sets the selected item to be the same value as the current item.

Returns:

  • (Array) 


169
170
171
172
173
 
# File 'lib/vedeu/models/menu.rb', line 169

def select_item
  @selected = @current

  items
end

#selected_item ⇒ |NilClass

Returns the item from the collection which shares the same index as the value of #selected.

Returns:

  • (|NilClass) 


85
86
87
88
89
 
# File 'lib/vedeu/models/menu.rb', line 85

def selected_item
  return nil unless @selected

  @collection[@selected]
end

#size ⇒ Fixnum

Returns the size of the collection.

Returns:

  • (Fixnum) 


194
195
196
 
# File 'lib/vedeu/models/menu.rb', line 194

def size
  @collection.size
end

#top_item ⇒ Array

Sets the value of current to be the first item of the collection.

Returns:

  • (Array) 


131
132
133
134
135
 
# File 'lib/vedeu/models/menu.rb', line 131

def top_item
  @current = 0

  items
end

#view ⇒ Array

Returns a subset of all the items.

Returns:

  • (Array) 


124
125
126
 
# File 'lib/vedeu/models/menu.rb', line 124

def view
  items[@current, @collection.size]
end