module SimpleNavigation # Represents an item in your navigation. Gets generated by the item method in the config-file. class Item attr_reader :key, :name, :url, :sub_navigation, :method, :highlights_on attr_writer :html_options # see ItemContainer#item # # The subnavigation (if any) is either provided by a block or passed in directly as items def initialize(container, key, name, url, options, items=nil, &sub_nav_block) @container = container @container.dom_class = options.delete(:container_class) if options[:container_class] @container.dom_id = options.delete(:container_id) if options[:container_id] @key = key @method = options.delete(:method) @name = name @url = url.instance_of?(Proc) ? url.call : url @highlights_on = options.delete(:highlights_on) @html_options = options if sub_nav_block || items @sub_navigation = ItemContainer.new(@container.level + 1) sub_nav_block.call @sub_navigation if sub_nav_block @sub_navigation.items = items if items end end # Returns true if this navigation item should be rendered as 'selected'. # An item is selected if # # * it has been explicitly selected in a controller or # * it has a subnavigation and one of its subnavigation items is selected or # * its url matches the url of the current request (auto highlighting) # def selected? @selected = @selected || selected_by_config? || selected_by_subnav? || selected_by_url? end # Returns the html-options hash for the item, i.e. the options specified for this item in the config-file. # It also adds the 'selected' class to the list of classes if necessary. def html_options default_options = self.autogenerate_item_ids? ? {:id => autogenerated_item_id} : {} options = default_options.merge(@html_options) options[:class] = [@html_options[:class], self.selected_class].flatten.compact.join(' ') options.delete(:class) if options[:class].nil? || options[:class] == '' options end # Returns the configured selected_class if the item is selected, nil otherwise # def selected_class selected? ? SimpleNavigation.config.selected_class : nil end protected # Returns true if item has a subnavigation and the sub_navigation is selected def selected_by_subnav? sub_navigation && sub_navigation.selected? end def selected_by_config? false end # Returns true if the item's url matches the request's current url. def selected_by_url? if highlights_on raise ArgumentError, ':highlights_on must be a regexp' unless highlights_on.instance_of?(Regexp) SimpleNavigation.request_uri =~ highlights_on elsif auto_highlight? !!(root_path_match? || SimpleNavigation.current_page?(url_without_anchor)) else false end end # Returns true if both the item's url and the request's url are root_path def root_path_match? url == '/' && SimpleNavigation.request_path == '/' end # Returns true if the item's id should be added to the rendered output. def autogenerate_item_ids? SimpleNavigation.config.autogenerate_item_ids end # Returns the item's id which is added to the rendered output. def autogenerated_item_id SimpleNavigation.config.id_generator.call(key) end # Return true if auto_highlight is on for this item. def auto_highlight? SimpleNavigation.config.auto_highlight && @container.auto_highlight end def url_without_anchor url.split('#').first end end end