Class: SimpleNavigation::ItemsProvider

Inherits:
Object
  • Object
show all
Defined in:
lib/simple_navigation/core/items_provider.rb

Overview

Acts as a proxy to navigation items that are passed into the SimpleNavigation::Configuration#items method. It hides the logic for finding items from the Configuration object.

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (ItemsProvider) initialize(provider)

It accepts the following types of provider:

  • methodname as symbol - the specified method should return the relevant items and has to be available in the view (a helper method)

  • object that responds to :items

  • enumerable object that represents the items

See SimpleNavigation::ItemAdapter for the requirements that need to be fulfilled by the provided items.



17
18
19
# File 'lib/simple_navigation/core/items_provider.rb', line 17

def initialize(provider)
  @provider = provider
end

Instance Attribute Details

- (Object) provider (readonly)

Returns the value of attribute provider



8
9
10
# File 'lib/simple_navigation/core/items_provider.rb', line 8

def provider
  @provider
end

Instance Method Details

- (Object) items

Returns the navigation items



22
23
24
25
26
27
28
29
30
31
32
# File 'lib/simple_navigation/core/items_provider.rb', line 22

def items
  if provider.instance_of?(Symbol)
    SimpleNavigation.context_for_eval.send(provider)
  elsif provider.respond_to?(:items)
    provider.items
  elsif provider.respond_to?(:each)
    provider
  else
    raise "items_provider either must be a symbol specifying the helper-method to call, an object with an items-method defined or an enumerable representing the items"
  end
end