ruby-simple-navigation 3.11.0-1 / usr / lib / ruby / vendor_ruby / simple_navigation / core / item_adapter.rb

require 'forwardable'

module SimpleNavigation

  # 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:
  #
  # * <tt>key</tt>
  # * <tt>name</tt>
  # * <tt>url</tt>
  #
  # and optionally
  #
  # * <tt>options</tt>
  # * <tt>items</tt> - 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.
  class ItemAdapter
    extend Forwardable
    
    def_delegators :item, :key, :name, :url

    attr_reader :item

    def initialize(item)
      @item = item.instance_of?(Hash) ? to_object(item) : item
    end

    # Returns the options for this item. If the wrapped item does not implement an options method, an empty hash is returned.
    def options
      @item.respond_to?(:options) ? @item.options : {}
    end

    # Returns the items (subnavigation) for this item if it responds to :items and the items-collection is not empty. Returns nil otherwise.
    def items
      (@item.respond_to?(:items) && !(@item.items.nil? || @item.items.empty?)) ? @item.items : nil
    end

    # Converts this Item into a SimpleNavigation::Item
    def to_simple_navigation_item(item_container)
      SimpleNavigation::Item.new(item_container, key, name, url, options, items)
    end

    protected
    
    # Converts the specified hash into an object. Each key will be added as method.
    #
    def to_object(hash)
      mod = Module.new do
        hash.each_pair do |key, value|
          define_method key do
            value
          end
        end
      end
      Object.new.extend(mod)
    end

  end
end