strikeroff-simple-navigation 2.0.2

data/CHANGELOG

@@ -0,0 +1 @@
+v2.0.2  add :level=>:all option for render_navigation

data/Manifest

@@ -0,0 +1,29 @@
+CHANGELOG
+generators/navigation_config/navigation_config_generator.rb
+generators/navigation_config/templates/config/navigation.rb
+generators/navigation_config/USAGE
+init.rb
+install.rb
+lib/simple_navigation/configuration.rb
+lib/simple_navigation/controller_methods.rb
+lib/simple_navigation/helpers.rb
+lib/simple_navigation/item.rb
+lib/simple_navigation/item_container.rb
+lib/simple_navigation/renderer/base.rb
+lib/simple_navigation/renderer/list.rb
+lib/simple_navigation.rb
+Manifest
+rails/init.rb
+Rakefile
+README
+spec/lib/simple_navigation/configuration_spec.rb
+spec/lib/simple_navigation/controller_methods_spec.rb
+spec/lib/simple_navigation/helpers_spec.rb
+spec/lib/simple_navigation/item_container_spec.rb
+spec/lib/simple_navigation/item_spec.rb
+spec/lib/simple_navigation/renderer/base_spec.rb
+spec/lib/simple_navigation/renderer/list_spec.rb
+spec/lib/simple_navigation_spec.rb
+spec/spec_helper.rb
+strikeroff-simple-navigation.gemspec
+uninstall.rb

data/README

@@ -0,0 +1,30 @@
+It is a fork of
+  http://github.com/andi/simple-navigation
+== Simple Navigation
+
+Simple Navigation is a plugin for creating a navigation (optionally with sub navigation) for your rails app.
+
+Source code:
+  git://github.com/andi/simple-navigation.git
+
+Documentation: 
+  http://wiki.github.com/andi/simple-navigation
+
+Online Demo:
+  http://simple-navigation-demo.andischacke.com
+
+Discussion Group for Feedback and Questions
+  http://groups.google.com/group/simple-navigation
+
+
+Diff from original
+   Some times you need to show all navigation tree on page(site map, for example), without config changes
+   Extra level :all can help you
+   
+     render_navigation(:level=>:all)
+
+
+
+
+Copyright (c) 2009 Andi Schacke, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('strikeroff-simple-navigation') do |p|
+
+  #fork of http://github.com/andi/simple-navigation
+  p.description    = "strikeroff-simple-navigation"
+  p.url            = "http://github.com/strikeroff"
+  p.author         = "Vesov Ilya"
+  p.email          = "strikeroff@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*", ".svn", ".git"]
+  p.need_tar_gz =     false
+  p.retain_gemspec =  true
+  p.gemspec_name =    'strikeroff-simple-navigation.gemspec'
+  p.test_pattern =    ["test/**/*_test.rb"]
+  p.rdoc_pattern =    ["README", "CHANGELOG", "lib/**/*.rb"]
+  p.rdoc_options <<   "-c utf-8"
+  p.ignore_pattern =  [".gitignore", "doc", ".idea",  "*.bat", "*.sh"]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/generators/navigation_config/USAGE

@@ -0,0 +1 @@
+Creates a template config file for the simple-navigation plugin. You will find the generated file in config/navigation.rb.

data/generators/navigation_config/navigation_config_generator.rb

@@ -0,0 +1,8 @@
+class NavigationConfigGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file "config/navigation.rb", "config/navigation.rb"
+      m.readme "../../../README"
+    end
+  end
+end

data/generators/navigation_config/templates/config/navigation.rb

@@ -0,0 +1,55 @@
+# Configures your navigation
+SimpleNavigation::Configuration.run do |navigation|  
+  # Specify a custom renderer if needed. 
+  # The default renderer is SimpleNavigation::Renderer::List which renders HTML lists.
+  # navigation.renderer = Your::Custom::Renderer
+  
+  # Specify the class that will be applied to active navigation items. Defaults to 'selected'
+  # navigation.selected_class = 'your_selected_class'
+  
+  # Normally only the current sub menu is renderedwhen render_navigation is called
+  # setting this to true render all submenus which is useful for javascript
+  # driven hovering menus like the jquery superfish plugin
+  # navigation.render_all_levels = true
+  
+  # Item keys are normally added to list items as id.
+  # This setting turns that off
+  # navigation.autogenerate_item_ids = false
+
+  # The auto highlight feature is turned on by default.
+  # This turns it off globally (for the whole plugin)
+  # navigation.auto_highlight = false
+
+  # Define the primary navigation
+  navigation.items do |primary|
+    # Add an item to the primary navigation. The following params apply:
+    # key - a symbol which uniquely defines your navigation item in the scope of the primary_navigation
+    # name - will be displayed in the rendered navigation. This can also be a call to your I18n-framework.
+    # url - the address that the generated item links to. You can also use url_helpers (named routes, restful routes helper, url_for etc.)
+    # options - can be used to specify attributes that will be included in the rendered navigation item (e.g. id, class etc.)
+    #
+    primary.item :key_1, 'name', url, options
+    
+    # Add an item which has a sub navigation (same params, but with block)
+    primary.item :key_2, 'name', url, options do |sub_nav|
+      # Add an item to the sub navigation (same params again)
+      sub_nav.item :key_2_1, 'name', url, options
+    end 
+  
+    # You can also specify a condition-proc that needs to be fullfilled to display an item.
+    # Conditions are part of the options. They are evaluated in the context of the views,
+    # thus you can use all the methods and vars you have available in the views.
+    primary.item :key_3, 'Admin', url, :class => 'special', :if => Proc.new { current_user.admin? }
+    primary.item :key_4, 'Account', url, :unless => Proc.new { logged_in? }
+
+    # you can also specify a css id or class to attach to this particular level
+    # works for all levels of the menu
+    # primary.dom_id = 'menu-id'
+    # primary.dom_class = 'menu-class'
+    
+    # You can turn off auto highlighting for a specific level
+    # primary.auto_highlight = false
+  
+  end
+  
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -0,0 +1,5 @@
+begin
+  puts IO.read(File.join(File.dirname(__FILE__), 'README'))
+rescue Exception => e
+  puts "The following error ocurred while installing the plugin: #{e.message}"
+end

data/lib/simple_navigation/configuration.rb

@@ -0,0 +1,66 @@
+require 'singleton'
+
+module SimpleNavigation
+  
+  # Responsible for evaluating and handling the config/navigation.rb file. 
+  class Configuration
+    include Singleton
+    
+    attr_accessor :renderer, :selected_class, :render_all_levels, :autogenerate_item_ids, :auto_highlight
+    attr_reader :primary_navigation
+
+    class << self
+
+      # Evals the config_file for the given navigation_context inside the specified context (usually a controller or view)
+      def eval_config(context, navigation_context = :default)
+        SimpleNavigation.controller = extract_controller_from context
+        SimpleNavigation.template = SimpleNavigation.controller.instance_variable_get(:@template)
+        context_for_eval.instance_eval(SimpleNavigation.config_files[navigation_context])
+      end
+      
+      # Starts processing the configuration
+      def run(&block)
+        block.call Configuration.instance
+      end    
+
+      # Returns the context in which the config file should be evaluated.
+      # This is preferably the template, otherwise te controller
+      def context_for_eval
+        raise 'no context set for evaluation the config file' unless SimpleNavigation.template || SimpleNavigation.controller
+        SimpleNavigation.template || SimpleNavigation.controller
+      end
+
+      # Extracts a controller from the context.
+      def extract_controller_from(context)
+        if context.respond_to? :controller
+          context.controller
+        else
+          context
+        end
+      end
+      
+    end #class << self
+    
+    # Sets the config's default-settings
+    def initialize
+      @renderer = SimpleNavigation::Renderer::List
+      @selected_class = 'selected'
+      @render_all_levels = false
+      @autogenerate_item_ids = true
+      @auto_highlight = true
+    end
+  
+    # Yields an SimpleNavigation::ItemContainer for adding navigation items
+    def items(&block)
+      @primary_navigation = ItemContainer.new
+      block.call @primary_navigation
+    end
+    
+    # Returns true if the config_file has already been evaluated.
+    def loaded?
+      !@primary_navigation.nil?
+    end    
+    
+  end  
+  
+end

data/lib/simple_navigation/controller_methods.rb

@@ -0,0 +1,79 @@
+#TODO: add :except and :only options to navigation method
+module SimpleNavigation
+  
+  # Adds methods for explicitely setting the current 'active' navigation to the controllers.
+  # Since version 2.0.0 the simple_navigation plugin determines the active navigation based on the current url by default (auto highlighting),
+  # so explicitely defining the active navigation in the controllers is only needed for edge cases where automatic highlighting does not work.
+  # 
+  # On the controller class level, use the <tt>navigation</tt> method to set the active navigation for all actions in the controller.
+  # Let's assume that we have a primary navigation item :account which in turn has a sub navigation item :settings.
+  # 
+  # ==== Examples
+  #   class AccountController << ActionController
+  #     navigation :account
+  #     ...
+  #   end
+  #
+  #   class AccountSettingsController << ActionController
+  #     navigation :settings
+  #     ...
+  #   end
+  #
+  # The first example sets the current primary navigation to :account for all actions. No active sub_navigation.
+  # The second example sets the current sub navigation to :settings and since it is a child of :account the current primary navigation is set to :account.
+  # 
+  # On the controller instance level, use the <tt>current_navigation</tt> method to define the active navigation for a specific action. 
+  # The navigation item that is set in <tt>current_navigation</tt> overrides the one defined on the controller class level (see <tt>navigation</tt> method).
+  # Thus if you have an :account primary item with a :special sub navigation item:
+  #
+  # ==== Example
+  #   class AccountController << ActionController
+  #     navigation :account
+  #     
+  #     def your_special_action
+  #       ...
+  #       current_navigation :special
+  #     end
+  #   end
+  #
+  # The code above still sets the active primary navigation to :account for all actions, but sets the sub_navigation to :account -> :special for 'your_special_action'.
+  #
+  # Note 1: As you can see above you just have to set the navigation item of your 'deepest' navigation level as active and all its parents are marked as active, too.
+  #
+  # Note 2: The specified symbols must match the keys for your navigation items in your config/navigation.rb file.
+  module ControllerMethods
+    def self.included(base) #:nodoc:
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+        include SimpleNavigation::Helpers
+        base.helper_method :render_navigation, :render_primary_navigation, :render_sub_navigation
+      end
+    end
+  
+    module ClassMethods
+      # Sets the active navigation for all actions in this controller.
+      #
+      # The specified symbol must match the keys for your navigation items in your config/navigation.rb file.  
+      def navigation(*args)
+        self.class_eval do
+          define_method :sn_set_navigation do
+            current_navigation(*args)
+          end
+          before_filter :sn_set_navigation
+        end
+      end
+    end
+  
+    module InstanceMethods
+      # Sets the active navigation. Call this method in any action to override the controller-wide active navigation
+      # specified by navigation.
+      #
+      # The specified symbol must match the keys for your navigation items in your config/navigation.rb file.
+      def current_navigation(*args)
+        @sn_current_navigation_args = args
+      end
+    end
+
+  end
+end

data/lib/simple_navigation/helpers.rb

@@ -0,0 +1,82 @@
+module SimpleNavigation
+
+  # View helpers to render the navigation.
+  #
+  # Use render_navigation as following to render your navigation:
+  # * call <tt>render_navigation</tt> without :level option to render your navigation as nested tree.
+  # * call <tt>render_navigation(:level => x)</tt> to render a specific navigation level (e.g. :level => 1 to render your primary navigation, :level => 2 to render the sub navigation and so forth)
+  #
+  # ==== Examples (using Haml)
+  #   #primary_navigation= render_navigation(:level => 1)
+  #
+  #   #sub_navigation= render_navigation(:level => 2)
+  #
+  #   #nested_navigation= render_navigation
+  #
+  # Please note that <tt>render_primary_navigation</tt> and <tt>render_sub_navigation</tt> still work, but have been deprecated and may be removed in a future release.
+  module Helpers
+
+    # Renders the navigation according to the specified options-hash.
+    #
+    # The following options are supported:
+    # * <tt>:level</tt> - defaults to :nested which renders the the sub_navigation for an active primary_navigation inside that active primary_navigation item.
+    #   Specify a specific level to only render that level of navigation (e.g. :level => 1 for primary_navigation etc...).
+    # * <tt>:context</tt> - specifies the context for which you would render the navigation. Defaults to :default which loads the default navigation.rb (i.e. config/navigation.rb).
+    #   If you specify a context then the plugin tries to load the configuration file for that context, e.g. if you call <tt>render_navigation(:context => :admin)</tt> the file config/admin_navigation.rb
+    #   will be loaded and used for rendering the navigation.
+    #
+    def render_navigation(*args)
+      args = [Hash.new] if args.empty?
+      options = extract_backwards_compatible_options(*args)
+      options = {:context => :default, :level => :nested}.merge(options)
+      SimpleNavigation.load_config(options[:context])
+      SimpleNavigation::Configuration.eval_config(self, options[:context])
+      SimpleNavigation.handle_explicit_navigation
+      case options[:level]
+        when Integer
+          active_item_container = SimpleNavigation.active_item_container_for(options[:level])
+          active_item_container.render if active_item_container
+        when :nested
+          SimpleNavigation.primary_navigation.render(true)
+        when :all
+          SimpleNavigation.primary_navigation.render(true,:all=>true)
+        else
+          raise ArgumentError, "Invalid navigation level: #{options[:level]}"
+      end
+    end
+
+    # Deprecated. Renders the primary_navigation with the configured renderer. Calling render_navigation(:level => 0) has the same effect.
+    def render_primary_navigation(options = {})
+      ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprected. Please use render_navigation(:level => 1) instead")
+      render_navigation(options.merge(:level => 1))
+    end
+
+    # Deprecated. Renders the sub_navigation with the configured renderer. Calling render_navigation(:level => 1) has the same effect.
+    def render_sub_navigation(options = {})
+      ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprected. Please use render_navigation(:level => 2) instead")
+      render_navigation(options.merge(:level => 2))
+    end
+
+    private
+
+    def extract_backwards_compatible_options(*args)
+      case args.first
+        when Hash
+          options = args.first
+          options[:level] = 1 if options[:level] == :primary
+          options[:level] = 2 if options[:level] == :secondary
+        when Symbol
+          raise ArgumentError, "Invalid arguments" unless [:primary, :secondary, :nested].include? args.first
+          options = Hash.new
+          options[:level] = args.first
+          options[:level] = 1 if options[:level] == :primary
+          options[:level] = 2 if options[:level] == :secondary
+          options.merge!(args[1] || {})
+        else
+          raise ArgumentError, "Invalid arguments"
+      end
+      options
+    end
+
+  end
+end

data/lib/simple_navigation/item.rb

@@ -0,0 +1,89 @@
+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
+    attr_writer :html_options
+    
+    # see ItemContainer#item
+    def initialize(container, key, name, url, options, sub_nav_block) #:nodoc:
+      @container = container
+      @key = key
+      @method = options.delete(:method)
+      @name = name
+      @url = url
+      @html_options = options
+      if sub_nav_block
+        @sub_navigation = ItemContainer.new(@container.level + 1)
+        sub_nav_block.call @sub_navigation
+      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 => key.to_s} : {}
+      options = default_options.merge(@html_options)
+      options[:class] = [@html_options[:class], self.selected_class].flatten.compact.join(' ')
+      options.delete(:class) if options[:class].blank?
+      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
+
+    # Return true if item has explicitly selected in controllers
+    def selected_by_config?
+      key == @container.current_explicit_navigation
+    end
+
+    # Returns true if the item's url matches the request's current url.
+    def selected_by_url?
+      if auto_highlight?
+        !!(root_path_match? || (SimpleNavigation.template && SimpleNavigation.template.current_page?(url)))
+      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.controller.request.path == '/'
+    end
+
+    # Converts url to url_hash. Accesses routing system, quite slow... Not used at the moment
+    # def hash_for_url(url) #:nodoc:
+    #   ActionController::Routing::Routes.recognize_path(url, {:method => (method || :get)})
+    # end
+
+    def autogenerate_item_ids?
+      SimpleNavigation.config.autogenerate_item_ids
+    end
+
+    def auto_highlight?
+      SimpleNavigation.config.auto_highlight && @container.auto_highlight
+    end
+
+  end
+end

data/lib/simple_navigation/item_container.rb

@@ -0,0 +1,119 @@
+module SimpleNavigation
+
+  # Holds the Items for a navigation 'level'.
+  class ItemContainer
+
+    attr_reader :items, :level
+    attr_accessor :renderer, :dom_id, :dom_class, :auto_highlight
+
+    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.)
+    #
+    # The <tt>options</tt> can be used to specify the following things:
+    # * <tt>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.
+    #
+    # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
+    def item(key, name, url, options={}, &block)
+      (@items << SimpleNavigation::Item.new(self, key, name, url, options, block)) if should_add_item?(options)
+    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.
+    #
+    # Set <tt>include_sub_navigation</tt> to true if you want to nest the sub_navigation into the active parent_navigation
+    def render(include_sub_navigation=false, options={})
+      self.renderer.new.render(self, include_sub_navigation, options)
+    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
+      self[current_explicit_navigation] || items.find {|i| i.selected?}
+    end
+
+    # Returns the current navigation that has been explicitely defined in the controller for this container's level.
+    # Returns nil if no explicit current navigation has been set.
+    #
+    def current_explicit_navigation
+      SimpleNavigation.current_navigation_for(level)
+    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
+
+    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/renderer/base.rb

@@ -0,0 +1,44 @@
+module SimpleNavigation
+  module Renderer
+
+    # This is the base class for all renderers.
+    #
+    # A renderer is responsible for rendering an ItemContainer and its containing items to HTML.
+    class Base
+      include ActionView::Helpers::UrlHelper
+      include ActionView::Helpers::TagHelper
+
+      attr_reader :controller
+
+      class << self
+
+        # Delegates method calls to the controller.
+        def controller_method(*methods)
+          methods.each do |method|
+            delegate method, :to => :controller
+          end
+        end
+
+      end
+
+      controller_method :form_authenticity_token, :protect_against_forgery?, :request_forgery_protection_token
+
+      def initialize #:nodoc:
+        @controller = SimpleNavigation.controller
+      end
+
+      # Renders the specified ItemContainer to HTML.
+      #
+      # If <tt>include_sub_navigation</tt> is set to true, the renderer should nest the sub_navigation for the active navigation
+      # inside that navigation item.
+      #
+      # A renderer should also take the option SimpleNavigation.config.render_all_levels into account. If it is set to true then it should render all navigation levels
+      # independent of the <tt>include_sub_navigation</tt> option.
+      #
+      def render(item_container, include_sub_navigation=false,options={})
+        raise 'subclass responsibility'
+      end
+
+    end
+  end
+end