jordanyeo-simple-navigation 3.11.0

data/lib/simple_navigation/core.rb

@@ -0,0 +1,5 @@
+require 'simple_navigation/core/configuration'
+require 'simple_navigation/core/item_adapter'
+require 'simple_navigation/core/item'
+require 'simple_navigation/core/item_container'
+require 'simple_navigation/core/items_provider'

data/lib/simple_navigation/core/configuration.rb

@@ -0,0 +1,72 @@
+require 'singleton'
+
+module SimpleNavigation
+
+  # Responsible for evaluating and handling the config/navigation.rb file.
+  class Configuration
+    include Singleton
+
+    attr_accessor :renderer, :selected_class, :active_leaf_class, :autogenerate_item_ids, :id_generator, :auto_highlight, :name_generator
+    attr_reader :primary_navigation
+
+    class << self
+
+      # Evals the config_file for the given navigation_context
+      def eval_config(navigation_context = :default)
+        SimpleNavigation.context_for_eval.instance_eval(SimpleNavigation.config_files[navigation_context])
+      end
+
+      # Starts processing the configuration
+      def run(&block)
+        block.call Configuration.instance
+      end
+
+    end #class << self
+
+    # Sets the config's default-settings
+    def initialize
+      @renderer = SimpleNavigation.default_renderer || SimpleNavigation::Renderer::List
+      @selected_class = 'selected'
+      @active_leaf_class = 'simple-navigation-active-leaf'
+      @autogenerate_item_ids = true
+      @id_generator = Proc.new {|id| id.to_s }
+      @name_generator = Proc.new {|name| name}
+      @auto_highlight = true
+    end
+
+    # This is the main method for specifying the navigation items. It can be used in two ways:
+    #
+    # 1. Declaratively specify your items in the config/navigation.rb file using a block. It then yields an SimpleNavigation::ItemContainer for adding navigation items.
+    # 1. Directly provide your items to the method (e.g. when loading your items from the database).
+    #
+    # ==== Example for block style (configuration file)
+    #   config.items do |primary|
+    #     primary.item :my_item, 'My item', my_item_path
+    #     ...
+    #   end
+    #
+    # ==== To consider when directly providing items
+    # items_provider should be:
+    # * a methodname (as symbol) that returns your items. The method needs to be available in the view (i.e. a helper method)
+    # * an object that responds to :items
+    # * an enumerable containing your items
+    # The items you specify have to fullfill certain requirements. See SimpleNavigation::ItemAdapter for more details.
+    #
+    def items(items_provider=nil, &block)
+      raise 'please specify either items_provider or block, but not both' if (items_provider && block) || (items_provider.nil? && block.nil?)
+      @primary_navigation = ItemContainer.new
+      if block
+        block.call @primary_navigation
+      else
+        @primary_navigation.items = SimpleNavigation::ItemsProvider.new(items_provider).items
+      end
+    end
+
+    # Returns true if the config_file has already been evaluated.
+    def loaded?
+      !@primary_navigation.nil?
+    end    
+        
+  end  
+  
+end

data/lib/simple_navigation/core/item.rb

@@ -0,0 +1,144 @@
+module SimpleNavigation
+
+  # Represents an item in your navigation. Gets generated by the item method in the config-file.
+  class Item
+    attr_reader :key, :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 <tt>items</tt>
+    def initialize(container, key, name, url_or_options = {}, options_or_nil={}, items=nil, &sub_nav_block)
+      @container = container
+      options = setup_url_and_options(url_or_options, options_or_nil)
+      @container.dom_class = options.delete(:container_class) if options[:container_class]
+      @container.dom_id = options.delete(:container_id) if options[:container_id]
+      @container.selected_class = options.delete(:selected_class) if options[:selected_class]
+      @key = key
+      @method = options.delete(:method)
+      @name = name
+      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 the item's name. If option :apply_generator is set to true (default),
+    # the name will be passed to the name_generator specified in the configuration.
+    #
+    def name(options = {})
+      options.reverse_merge!(:apply_generator => true)
+      if (options[:apply_generator])
+        SimpleNavigation.config.name_generator.call(@name)
+      else
+        @name
+      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_condition?
+    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, self.active_leaf_class].flatten.compact.join(' ')
+      options.delete(:class) if options[:class].nil? || options[:class] == ''
+      options
+    end
+
+    # Returns the configured active_leaf_class if the item is the selected leaf,
+    # nil otherwise
+    def active_leaf_class
+      !selected_by_subnav? && selected_by_condition? ? SimpleNavigation.config.active_leaf_class : nil
+    end
+
+    # Returns the configured selected_class if the item is selected,
+    # nil otherwise
+    def selected_class
+      selected? ? (@container.selected_class || 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_condition?
+      if highlights_on
+        case highlights_on
+        when Regexp
+          SimpleNavigation.request_uri =~ highlights_on
+        when Proc
+          highlights_on.call
+        when :subpath
+          !!(SimpleNavigation.request_uri =~ /^#{Regexp.escape url_without_anchor}(\/|$|\?)/i)
+        else
+          raise ArgumentError, ':highlights_on must be a Regexp, Proc or :subpath'
+        end
+      elsif auto_highlight?
+        !!(root_path_match? || (url_without_anchor && 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 && url.split('#').first
+    end
+
+    private
+    def setup_url_and_options(url_or_options, options_or_nil)
+      options = options_or_nil
+      url = url_or_options
+      case url_or_options
+      when Hash
+        # url_or_options is options (there is no url)
+        options = url_or_options
+      when Proc
+        @url = url.call
+      else
+        @url = url
+      end
+      @highlights_on = options.delete(:highlights_on)
+      @html_options = options
+    end
+  end
+end

data/lib/simple_navigation/core/item_adapter.rb

@@ -0,0 +1,63 @@
+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.is_a?(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

data/lib/simple_navigation/core/item_container.rb

@@ -0,0 +1,147 @@
+module SimpleNavigation
+
+  # Holds the Items for a navigation 'level'.
+  class ItemContainer
+
+    attr_reader :items, :level
+    attr_accessor :renderer, :dom_id, :dom_class, :auto_highlight, :selected_class
+
+    def initialize(level=1) #:nodoc:
+      @level = level
+      @items = []
+      @renderer = SimpleNavigation.config.renderer
+      @auto_highlight = true
+    end
+
+    # Creates a new navigation item.
+    #
+    # The <tt>key</tt> is a symbol which uniquely defines your navigation item in the scope of the primary_navigation or the sub_navigation.
+    #
+    # The <tt>name</tt> will be displayed in the rendered navigation. This can also be a call to your I18n-framework.
+    #
+    # The <tt>url</tt> is the address that the generated item points to. You can also use url_helpers (named routes, restful routes helper, url_for etc.) <tt>url</tt> is optional - items without URLs should not be rendered as links.
+    #
+    # The <tt>options</tt> can be used to specify the following things:
+    # * <tt>any html_attributes</tt> - will be included in the rendered navigation item (e.g. id, class etc.)
+    # * <tt>:if</tt> - Specifies a proc to call to determine if the item should
+    #   be rendered (e.g. <tt>:if => Proc.new { current_user.admin? }</tt>). The
+    #   proc should evaluate to a true or false value and is evaluated in the context of the view.
+    # * <tt>:unless</tt> - Specifies a proc to call to determine if the item should not
+    #   be rendered (e.g. <tt>:unless => Proc.new { current_user.admin? }</tt>). The
+    #   proc should evaluate to a true or false value and is evaluated in the context of the view.
+    # * <tt>:method</tt> - Specifies the http-method for the generated link - default is :get.
+    # * <tt>:highlights_on</tt> - if autohighlighting is turned off and/or you want to explicitly specify
+    #   when the item should be highlighted, you can set a regexp which is matched againstthe current URI.
+    #
+    # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
+    def item(key, name, url_or_options = {}, options_or_nil = {}, &block)
+      options = url_or_options.is_a?(Hash) ? url_or_options : options_or_nil
+      (@items << SimpleNavigation::Item.new(self, key, name, url_or_options, options_or_nil, nil, &block)) if should_add_item?(options)
+    end
+
+    def items=(items)
+      items.each do |item|
+        item = SimpleNavigation::ItemAdapter.new(item)
+        (@items << item.to_simple_navigation_item(self)) if should_add_item?(item.options)
+      end
+    end
+
+    # Returns the Item with the specified key, nil otherwise.
+    #
+    def [](navi_key)
+      items.find {|i| i.key == navi_key}
+    end
+
+    # Returns the level of the item specified by navi_key.
+    # Recursively works its way down the item's sub_navigations if the desired item is not found directly in this container's items.
+    # Returns nil item cannot be found.
+    #
+    def level_for_item(navi_key)
+      my_item = self[navi_key]
+      return self.level if my_item
+      items.each do |i|
+        if i.sub_navigation
+          level = i.sub_navigation.level_for_item(navi_key)
+          return level unless level.nil?
+        end
+      end
+      return nil
+    end
+
+    # Renders the items in this ItemContainer using the configured renderer.
+    #
+    # The options are the same as in the view's render_navigation call (they get passed on)
+    def render(options={})
+      renderer_instance = if options[:renderer]
+        if options[:renderer].instance_of?(Symbol) && SimpleNavigation.registered_renderers.key?(options[:renderer])
+          SimpleNavigation.registered_renderers[options[:renderer]].new(options)
+        else
+          options[:renderer].new(options)
+        end
+      else
+        self.renderer.new(options)
+      end
+      renderer_instance.render(self)
+    end
+
+    # Returns true if any of this container's items is selected.
+    #
+    def selected?
+      items.any? {|i| i.selected?}
+    end
+
+    # Returns the currently selected item, nil if no item is selected.
+    #
+    def selected_item
+      items.find {|i| i.selected?}
+    end
+
+    # Returns the active item_container for the specified level
+    # (recursively looks up items in selected sub_navigation if level is deeper than this container's level).
+    #
+    def active_item_container_for(desired_level)
+      return self if self.level == desired_level
+      return nil unless selected_sub_navigation?
+      return selected_item.sub_navigation.active_item_container_for(desired_level)
+    end
+    
+    # Returns the deepest possible active item_container. 
+    # (recursively searches in the sub_navigation if this container has a selected sub_navigation). 
+    def active_leaf_container
+      if selected_sub_navigation?
+        selected_item.sub_navigation.active_leaf_container
+      else
+        self
+      end
+    end
+
+    # Returns true if there are no items defined for this container.
+    def empty?
+      items.empty?
+    end
+
+    private
+
+    def selected_sub_navigation?
+      !!(selected_item && selected_item.sub_navigation)
+    end
+
+    # partially borrowed from ActionSupport::Callbacks
+    def should_add_item?(options) #:nodoc:
+      [options.delete(:if)].flatten.compact.all? { |m| evaluate_method(m) } &&
+      ![options.delete(:unless)].flatten.compact.any? { |m| evaluate_method(m) }
+    end
+
+    # partially borrowed from ActionSupport::Callbacks
+    def evaluate_method(method) #:nodoc:
+      case method
+        when Proc, Method
+          method.call
+        else
+          raise ArgumentError, ":if or :unless must be procs or lambdas"
+      end
+    end
+
+  end
+
+end

data/lib/simple_navigation/core/items_provider.rb

@@ -0,0 +1,35 @@
+module SimpleNavigation
+
+  # 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.
+  #
+  class ItemsProvider
+
+    attr_reader :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.
+    #
+    def initialize(provider)
+      @provider = provider
+    end
+
+    # Returns the navigation items
+    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
+
+  end
+end