Class: SimpleNavigation::ItemAdapter

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/simple_navigation/item_adapter.rb

Overview

This class acts as an adapter to items that are not defined using the DSL in the config/navigation.rb, but directly provided inside the application. When defining the items that way, every item you provide needs to define the following methods:

  • key

  • name

  • url

and optionally

  • options

  • items - if one of your items has a subnavigation it must respond

    to <tt>items</tt> providing the subnavigation.

You can also specify your items as a list of hashes. The hashes will be converted to objects automatically. The hashes representing the items obviously must have the keys :key, :name and :url and optionally the keys :options and :items.

See SimpleNavigation::ItemContainer#item for the purpose of these methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(item) ⇒ ItemAdapter

Returns a new instance of ItemAdapter.



33
34
35
 
# File 'lib/simple_navigation/item_adapter.rb', line 33

def initialize(item)
  @item = item.is_a?(Hash) ? OpenStruct.new(item) : item
end

Instance Attribute Details

#item ⇒ Object (readonly)

Returns the value of attribute item.



31
32
33
 
# File 'lib/simple_navigation/item_adapter.rb', line 31

def item
  @item
end

Instance Method Details

#items ⇒ Object

Returns the items (subnavigation) for this item if it responds to :items and the items-collection is not empty. Returns nil otherwise.



45
46
47
 
# File 'lib/simple_navigation/item_adapter.rb', line 45

def items
  item.items if item.respond_to?(:items) && item.items && item.items.any?
end

#options ⇒ Object

Returns the options for this item. If the wrapped item does not implement an options method, an empty hash is returned.



39
40
41
 
# File 'lib/simple_navigation/item_adapter.rb', line 39

def options
  item.respond_to?(:options) ? item.options : {}
end

#to_simple_navigation_item(item_container) ⇒ Object

Converts this Item into a SimpleNavigation::Item



50
51
52
 
# File 'lib/simple_navigation/item_adapter.rb', line 50

def to_simple_navigation_item(item_container)
  SimpleNavigation::Item.new(item_container, key, name, url, options)
end