krasivotokak-simple-navigation 1.4.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+rdoc
+pkg

data/CHANGELOG

@@ -0,0 +1,38 @@
+*master
+
+*1.4.0 
+
+* added the capability to have several navigation-contexts
+* doc-fix
+
+*1.3.1
+
+* now compliant with ruby 1.9.1 (thanks to Gernot Kogler for the feedback)
+
+*1.3.0
+
+* render_all_levels-option allows to render all subnavigation independent from the active primary navigation ('full open tree'). Userful for javascript menus. Thanks to Richard Hulse.
+* ability to turn off automatic generation of dom_ids for the list items (autogenerate_item_ids). Credits again to Richard Hulse.
+* ability to specify dom_class for primary and secondary lists. Thanks Richard!
+
+*1.2.2
+
+* renderers now have access to request_forgery_protection stuff (this allows delete-links as navigation-items)
+
+*1.2.1
+
+* changed way to include render_*-helper_methods into view (including them into Controller and declaring them as helper_methods instead of adding whole module as Helper). this seems to be more reliable under certain conditions. Credits to Gernot Kogler.
+
+*1.2.0
+
+* added capability to add conditions to navigation-items (primary.item key, name, url, :if => Proc.new {current_user.admin?})
+
+*1.1.2
+
+* Bugfix: config now gets evaluated on every render_navigation call. Credits to Joël Azémar.
+* Config file gets reloaded on every render_navigation call in development mode. Only load config file on server start in production mode.
+
+
+*1.1.1
+
+* Change plugin into a GemPlugin

data/README

@@ -0,0 +1,19 @@
+
+== 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
+
+Copyright (c) 2009 Andi Schacke, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate documentation for the simple_navigation plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimpleNavigation'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "simple-navigation"
+    gemspec.summary = "Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app."
+    gemspec.email = "andreas.schacke@gmail.com"
+    gemspec.homepage = "http://github.com/andi/simple-navigation"
+    gemspec.description = "Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app."
+    gemspec.authors = ["Andi Schacke", 'Alexander Semyonov']
+    gemspec.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+    gemspec.files += ["CHANGELOG"]
+    gemspec.rubyforge_project = 'andi'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/andi/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 1
+:minor: 4

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,48 @@
+# 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.
+  # this setting turns that off
+  # navigation.autogenerate_item_ids = 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'
+  
+  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.rb

@@ -0,0 +1,40 @@
+# A plugin for generating a simple navigation. See README for resources on usage instructions.
+module SimpleNavigation
+
+  mattr_accessor :config_files
+  mattr_accessor :config_file_path
+  mattr_accessor :controller
+  self.config_files = {}
+  
+  class << self
+  
+    # Reads the config_file for the specified navigation_context and stores it for later evaluation.
+    def load_config(navigation_context = :default)
+      raise "config_file_path is not set!" unless self.config_file_path
+      raise "Config file '#{config_file_name(navigation_context)}' does not exists!" unless File.exists?(config_file_name(navigation_context))
+      if ::RAILS_ENV == 'production'
+        self.config_files[navigation_context] ||= IO.read(config_file_name(navigation_context))
+      else
+        self.config_files[navigation_context] = IO.read(config_file_name(navigation_context))
+      end
+    end
+
+    # Returns the singleton instance of the SimpleNavigation::Configuration
+    def config 
+      Configuration.instance
+    end
+  
+    # Returns the ItemContainer that contains the items for the primary navigation
+    def primary_navigation
+      config.primary_navigation
+    end
+  
+    # Returns the path to the config_file for the given navigation_context
+    def config_file_name(navigation_context = :default)
+      file_name = navigation_context == :default ? '' : "#{navigation_context.to_s.underscore}_"
+      File.join(config_file_path, "#{file_name}navigation.rb")
+    end
+
+  end
+
+end

data/lib/simple_navigation/configuration.rb

@@ -0,0 +1,60 @@
+require 'singleton'
+
+module SimpleNavigation
+  
+  # Responsible for evaluating and handling the config/navigation.rb file. 
+  class Configuration
+    include Singleton
+    
+    attr_accessor :renderer
+    attr_accessor :selected_class
+    attr_accessor :render_all_levels
+    attr_accessor :autogenerate_item_ids
+    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)
+        context.instance_eval(SimpleNavigation.config_files[navigation_context])
+        SimpleNavigation.controller = extract_controller_from context
+      end
+
+      # Starts processing the configuration
+      def run(&block)
+        block.call Configuration.instance
+      end    
+
+      # Extracts a controller from the context.
+      def extract_controller_from(context)
+        if context.respond_to? :controller
+          context.controller
+        else
+          context
+        end
+      end
+
+    end
+    
+    # Sets the config's default-settings
+    def initialize
+      @renderer = SimpleNavigation::Renderer::List
+      @selected_class = 'selected'
+      @render_all_levels = false
+      @autogenerate_item_ids = 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,75 @@
+#TODO: add :except and :only options to navigation method
+module SimpleNavigation
+  
+  # Adds methods for handling the current 'active' navigation to the controllers.
+  # 
+  # On the controller class level, use the navigation method to set the active navigation for all actions in the controller.
+  # 
+  # ==== Examples
+  #   class AccountController << ActionController
+  #     navigation :account
+  #     ...
+  #   end
+  #
+  #   class AccountSettingsController << ActionController
+  #     navigation :account, :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_primary_navigation to :account and the current_sub_navigation to :settings.
+  # 
+  # On the controller instance level, use the current_navigation method to define the active navigation for a specific action. 
+  # The navigation item that is set in current_navigation overrides the one defined on the controller class level (see navigation method).
+  #
+  # ==== Example
+  #   class AccountController << ActionController
+  #     navigation :account
+  #     
+  #     def your_special_action
+  #       ...
+  #       current_navigation :account, :special
+  #     end
+  #   end
+  #
+  # The code above still sets the active primary navigation to :account but also sets the sub_navigation to :special for 'your_special_action'.
+  #
+  # Note: 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 symbols must match the keys for your navigation items in your config/navigation.rb file.  
+      def navigation(primary_navigation, sub_navigation=nil)
+        self.class_eval do
+          define_method :set_navigation do
+            current_navigation(primary_navigation, sub_navigation)
+          end
+          before_filter :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 symbols must match the keys for your navigation items in your config/navigation.rb file.
+      def current_navigation(primary_navigation, sub_navigation=nil)
+        @current_primary_navigation = primary_navigation
+        @current_secondary_navigation = sub_navigation
+      end
+    end
+
+  end
+end

data/lib/simple_navigation/helpers.rb

@@ -0,0 +1,65 @@
+module SimpleNavigation
+  
+  # View helpers to render the navigation.
+  #
+  # Use render_primary_navigation to render your primary navigation with the configured renderer.
+  # Use render_sub_navigation to render the sub navigation belonging to the active primary navigation.
+  # Use render_navigation to render the primary navigation with the corresponding sub navigation rendered inside primary navigation item which is active.
+  # 
+  # ==== Examples (using Haml)
+  #   #primary_navigation= render_primary_navigation
+  #   
+  #   #sub_navigation= render_sub_navigation
+  #
+  #   #main_navigation= render_navigation
+  #
+  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. 
+    #   Other possible levels are :primary which only renders the primary_navigation (also see render_primary_navigation) and :secondary which only renders the sub_navigation (see render_sub_navigation).
+    # * <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?
+      default_options = {:context => :default, :level => :nested}
+      level, navigation_context = case args.first 
+      when Hash
+        options = default_options.merge(args.first)
+        [options[:level], options[:context]]
+      when Symbol
+        [args[0], default_options.merge(args[1] || {})[:context]]
+      else
+        raise ArgumentError, "Invalid arguments"
+      end
+      SimpleNavigation.load_config(navigation_context)
+      SimpleNavigation::Configuration.eval_config(self, navigation_context)
+      case level
+      when :primary
+        SimpleNavigation.primary_navigation.render(@current_primary_navigation)
+      when :secondary
+        primary = SimpleNavigation.primary_navigation[@current_primary_navigation]
+        primary.sub_navigation.render(@current_secondary_navigation) if primary && primary.sub_navigation
+      when :nested
+        SimpleNavigation.primary_navigation.render(@current_primary_navigation, true, @current_secondary_navigation)
+      else
+        raise ArgumentError, "Invalid navigation level: #{level}"
+      end
+    end
+    
+    # Renders the primary_navigation with the configured renderer. Calling render_navigation(:level => :primary) has the same effect.
+    def render_primary_navigation(options = {})
+      render_navigation(options.merge(:level => :primary))
+    end
+    
+    # Renders the sub_navigation with the configured renderer. Calling render_navigation(:level => :secondary) has the same effect.
+    def render_sub_navigation(options = {})
+      render_navigation(options.merge(:level => :secondary))
+    end
+    
+  end
+end