simple-navigation-ext 0.0.1

data/CHANGELOG

@@ -0,0 +1,177 @@
+*3.1.1
+
+* Item#selected_by_url? now strips anchors from the item's url before comparing it with the current request's url. Credits to opengovernment.
+
+*3.1.0
+
+* added new helper method 'active_navigation_item_name' to render the name of the currently active item
+
+*3.0.2
+
+* dom_id and dom_class can now be set as option in the item's definition (useful for dynamic menu items).
+
+*3.0.1
+
+* allow controller instance variables named @template for rails3 apps. Credits to cmartyn.
+* added possibility to specify and item's URL as a block which is evaulated after the :if and :unless conditions have been checked. Credits to Nicholas Firth-McCoy.
+* upgraded to rspec 2.0.0
+* fixed cgi error in sinatra adapter. Credits to Jack Dempsey.
+
+*3.0.0
+
+* added ability to specify dynamic items using an array of hashes. Credits to Anshul Khandelwal for input and discussion.
+* added ability to specify attributes for the generated link-tag in list renderer (up to now the attributes have been applied to the li-tag). Credits to Anthony Navarre for input and discussion.
+
+*3.0.0.beta2
+
+* moving code for initializing plugin in sinatra to separate gem
+
+*3.0.0.beta1
+
+* moving deprecated rails controller methods (navigation, current_navigation) to separate file 'rails_controller_methods'. Deprecations removed. File can be required explicitly if controller methods should be still available.
+* decoupling from Rails. Introducing the concept of adapters to work with several frameworks. 
+* tested with Rails 3.0.0
+* adding support for Sinatra and Padrino frameworks.
+* cherry picking active_support stuff instead of requiring the whole bunch (tested with active_support >= 2.3.2 and 3.0.0)
+* created public sample project which includes demo for Rails2, Rails3, Sinatra and Padrino (will be available on github soon)
+* better src file organization (adapters/core/rendering folders)
+
+*2.7.3
+
+* initializing SimpleNavigation.config_file_path with empty array (was nil before). Allows for adding paths before gem has been initialized.
+
+*2.7.2
+
+* added ability to have more than one config_file_path (useful if simple-navigation is used as a part of another gem/plugin). Credits to Luke Imhoff.
+
+*2.7.1
+
+* added SimpleNavigation.request and SimpleNavigation.request_uri as abstraction for getting request_uri (rails2/rails3)
+* use request.fullpath instead of request.request_uri for Rails3. Credits to Ben Langfeld.
+
+*2.7.0
+
+* added new option :highlights_on to item definition in config-file. Specify a regexp which is matched against the current_uri to determine if an item is active or not. Replaces explicit highlighting in controllers.
+* deprecated explicit highlighting in the controllers.
+
+*2.6.0
+
+* added rendering option 'skip_if_empty' to Renderer::List to avoid rendering of empty ul-tags
+* added breadcrumbs renderer incl. specs. A big thanks to Markus Schirp.
+* added ability to register a renderer / specify your renderer as symbol in render_navigation
+* renderer can be specified in render_navigation. Credits to Andi Bade from Galaxy Cats.
+
+*2.5.4
+
+* bugfix: SimpleNavigation.config_file? without params does not check for _navigation.rb file anymore. Credits to Markus Schirp.
+
+*2.5.3
+
+* removed deprecated railtie_name from simple_navigation/railtie. Credits to Markus Schirp.
+
+*2.5.2
+
+* added Rails3 generator for navigation_config.rb. Thanks to Josep Jaume Rey.
+
+*2.5.1
+
+* set template correctly for Rails3 (brings auto highlighting to life again). Credits to Josep Jaume Rey.
+
+*2.5.0
+
+* added new renderer Renderer::Links to simply render the navigation as links inside a div.
+* also make item.name html_safe (in order you have html_code in the item's name). Thanks again, Johan Svensson.
+
+*2.4.2
+
+* Rails 3.0.0.beta2 compatibility
+* Renderer::List --> make content of ul-tag html_safe for rails 3.0.0.beta2 (due to rails3 XSS protection). Credits to Johan Svensson and Disha Albaqui.
+* updated copyright
+* reduced visibility of 'sn_set_navigation' to protected
+
+*2.4.1
+
+* removing depencency to rails. It installs the newest rails, even if a matching version is present. why is that?
+
+*2.4.0
+
+* added Rails3 compatibility
+* added Jeweler::Gemcutter Tasks to Rakefile
+
+*2.2.3
+
+* changed error handling in config-file. Do not ignore errors in config-file anymore.
+* only load config-file if it is present. Needed when directly providing items in render_navigation.
+
+*2.2.2
+
+* added lib/simple-navigation.rb to allow 'require simple-navigation' or 'config.gem "simple-navigation"'
+
+*2.2.1
+
+* Corrected URL to API-Doc on rubyforge in README
+
+*2.2.0
+
+* Allow Ranges for :level option. Credits to Ying Tsen Hong.
+* Changing the API of Helpers#render_navigation. Now supports Ranges for :level option and :expand_all to render all levels as expanded. Old Api is still supported, but deprecated.
+* Deprecated render_all_levels in config-file.
+
+*2.1.0
+
+* included Ben Marini's commit which allows individual id-generators. Thanks Ben!
+* added ability to specify navigation items through items_provider. This is useful for generating the navigation dynamically (e.g. from database)
+* items can now even be passed directly into render_navigation method.
+
+*2.0.1
+
+* fixed handling of a non-existent explicit navigation item for a navigation context
+
+*2.0.0
+
+* added auto_highlight feature. Active navigation is determined by comparing urls, no need to explicitly set it in the controllers anymore. Thanks to Jack Dempsey and Florian Hanke for the support on this.
+* added ability to create multi-level navigations (not just limited to primary and secondary navigation). Thanks again to Jack Dempsey for the motivation ;-)
+* simplified the process to explicitly set the navigation in the controller (where needed) - only deepest level has to be specified
+* made auto_highlight feature configurable both on global and item_container's level
+* config file is now evaluated in template if ever possible (not in controller anymore)
+
+*1.4.2
+
+* explicitly loading all source files when requiring 'simple_navigation'.
+
+*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,22 @@
+
+== Simple Navigation
+
+Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Rails 2, Rails 3, Sinatra or Padrino applications.
+
+Source code:
+  git://github.com/andi/simple-navigation.git
+
+Documentation: 
+  http://wiki.github.com/andi/simple-navigation
+
+RDoc:
+  http://andi.rubyforge.org/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) 2010 Andi Schacke, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--colour --format progress']
+end
+
+namespace :spec do
+  desc "Run all specs with RCov"
+  RSpec::Core::RakeTask.new(:rcov) do |t|
+    t.rspec_opts = ['--colour --format progress']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec,/Users/']
+  end
+end
+
+desc 'Generate documentation for the simple_navigation_ext plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimpleNavigationExt'
+  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-ext"
+    gemspec.summary = "simple-navigation-ext is an extension of andi schacke's library and add the feature to explicitly exclude urls from highlighting."
+    gemspec.email = "info@screenconcept.ch"
+    gemspec.homepage = "https://github.com/screenconcept/simple-navigation"
+    gemspec.description = "simple-navigation-ext is an extension of andi schacke's library and add the feature to explicitly exclude urls from highlighting."
+    gemspec.add_development_dependency('rspec', '>= 2.0.1')
+    gemspec.add_dependency('activesupport', '>= 2.3.2')
+    gemspec.authors = ["Marco"]
+    gemspec.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+    gemspec.files = FileList["[A-Z]*", "{lib,spec,rails,generators}/**/*"] - FileList["**/*.log"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "Jeweler not available (#{e}). Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

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,67 @@
+# 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.
+  # The renderer can also be specified as option in the render_navigation call.
+  # 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'
+
+  # Item keys are normally added to list items as id.
+  # This setting turns that off
+  # navigation.autogenerate_item_ids = false
+
+  # You can override the default logic that is used to autogenerate the item ids.
+  # To do this, define a Proc which takes the key of the current item as argument.
+  # The example below would add a prefix to each key.
+  # navigation.id_generator = Proc.new {|key| "my-prefix-#{key}"}
+
+  # 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.)
+    #           some special options that can be set:
+    #           :if - 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.
+    #           :unless - 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.
+    #           :method - Specifies the http-method for the generated link - default is :get.
+    #           :highlights_on - 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
+    #                            against the current URI.
+    #
+    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/lib/generators/navigation_config/navigation_config_generator.rb

@@ -0,0 +1,12 @@
+class NavigationConfigGenerator < Rails::Generators::Base
+  def self.source_root
+    @source_root ||= File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','generators','navigation_config', 'templates'))
+  end
+
+  desc 'Creates a template config file for the simple-navigation plugin. You will find the generated file in config/navigation.rb.'
+  def navigation_config
+    copy_file('config/navigation.rb', 'config/navigation.rb')    
+    say File.read(File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','README')))
+  end
+  
+end

data/lib/simple-navigation.rb

@@ -0,0 +1 @@
+require 'simple_navigation'

data/lib/simple_navigation/adapters/base.rb

@@ -0,0 +1,37 @@
+module SimpleNavigation
+  module Adapters
+    
+    # This is the base class for all adapters. This class mainly exists for documenting reasons.
+    # It lists all the methods that an adapter should implement.
+    #
+    class Base
+      attr_reader :context, :request
+      
+      # This method is usually called when the framework is initialized. 
+      # It should call SimpleNavigation.set_env and install SimpleNavigation::Helpers where appropriate.
+      def self.register; end
+      
+      # Returns the full path incl. query params
+      def request_uri; end
+      
+      # Returns the path without query params
+      def request_path; end
+      
+      # Returns the context in which the config files will be evaluated
+      def context_for_eval; end
+      
+      # Returns true if the current request's url matches the specified url. 
+      # Used to determine if an item should be autohighlighted.
+      def current_page?(url); end
+      
+      # Returns a link with the specified name, url and options.
+      # Used for rendering.
+      def link_to(name, url, options={}); end
+      
+      # Returns a tag of the specified type, content and options.
+      # Used for rendering.
+      def content_tag(type, content, options={}); end
+      
+    end
+  end
+end

data/lib/simple_navigation/adapters/padrino.rb

@@ -0,0 +1,20 @@
+module SimpleNavigation
+  module Adapters
+    class Padrino < Sinatra
+      
+      def self.register
+        SimpleNavigation.set_env(PADRINO_ROOT, PADRINO_ENV)
+        ::Padrino::Application.send(:helpers, SimpleNavigation::Helpers)
+      end
+            
+      def link_to(name, url, options={})
+        context.link_to name, url, options
+      end
+      
+      def content_tag(type, content, options={})
+        context.content_tag type, content, options
+      end
+      
+    end
+  end
+end

data/lib/simple_navigation/adapters/rails.rb

@@ -0,0 +1,94 @@
+module SimpleNavigation
+  module Adapters
+    class Rails < Base
+            
+      attr_reader :controller, :template
+
+      def self.register
+        SimpleNavigation.set_env(rails_root, rails_env)        
+        ActionController::Base.send(:include, SimpleNavigation::Helpers)
+        ActionController::Base.send(:helper_method, :render_navigation)
+        ActionController::Base.send(:helper_method, :active_navigation_item_name)
+      end
+      
+      def initialize(context)
+        @controller = extract_controller_from context
+        @template = template_from @controller
+        @request = @template.request if @template
+      end
+      
+      def request_uri
+        return '' unless request
+        return request.fullpath if request.respond_to?(:fullpath)
+        request.request_uri
+      end
+      
+      def request_path
+        return '' unless request
+        request.path
+      end
+      
+      def context_for_eval
+        raise 'no context set for evaluation the config file' unless template || controller
+        template || controller
+      end
+      
+      def current_page?(url)
+        template.current_page?(url) if template
+      end
+      
+      def link_to(name, url, options={})
+        template.link_to(html_safe(name), url, options) if template
+      end
+      
+      def content_tag(type, content, options={})
+        template.content_tag(type, html_safe(content), options) if template
+      end
+      
+      protected
+      
+      def self.rails_root
+        rails3? ? ::Rails.root : ::RAILS_ROOT
+      end
+      
+      def self.rails_env
+        rails3? ? ::Rails.env : ::RAILS_ENV
+      end
+      
+      def self.rails3?
+        ::Rails::VERSION::MAJOR == 3
+      end
+      
+      def template_from(controller)
+        controller.respond_to?(:view_context) ? controller.view_context : controller.instance_variable_get(:@template)
+      end
+      
+      # Marks the specified input as html_safe (for Rails3). Does nothing if html_safe is not defined on input. 
+      #
+      def html_safe(input)
+        input.respond_to?(:html_safe) ? input.html_safe : input
+      end
+      
+      # Extracts a controller from the context.
+      def extract_controller_from(context)
+        if context.respond_to? :controller
+          context.controller
+        else
+          context
+        end
+      end
+         
+    end
+  end
+end
+
+# Initializer for Rails3
+if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  module SimpleNavigation                                                                                                
+    class Railtie < Rails::Railtie                                                                                       
+      initializer "simple_navigation.register" do |app|                                                             
+        SimpleNavigation.register
+      end                                                                                                                
+    end                                                                                                                  
+  end
+end

data/lib/simple_navigation/adapters/sinatra.rb

@@ -0,0 +1,68 @@
+require 'cgi'
+
+module SimpleNavigation
+  module Adapters
+    class Sinatra < Base
+      
+      def self.register
+        SimpleNavigation.set_env(sinatra_root, sinatra_environment)
+        ::Sinatra::Application.send(:helpers, SimpleNavigation::Helpers)
+      end
+      
+      def initialize(context)
+        @context = context
+        @request = context.request
+      end
+
+      def context_for_eval
+        raise 'no context set for evaluation the config file' unless context
+        context
+      end
+      
+      def request_uri
+        request.fullpath
+      end
+      
+      def request_path
+        request.path
+      end
+      
+      def current_page?(url)
+        url_string = CGI.unescape(url)
+        if url_string.index("?")
+          uri = request_uri
+        else
+          uri = request_uri.split('?').first
+        end
+        if url_string =~ /^\w+:\/\//
+          url_string == "#{request.protocol}#{request.host_with_port}#{uri}"
+        else
+          url_string == uri
+        end        
+      end
+      
+      def link_to(name, url, options={})
+        "<a href='#{url}' #{to_attributes(options)}>#{name}</a>"
+      end
+      
+      def content_tag(type, content, options={})
+        "<#{type} #{to_attributes(options)}>#{content}</#{type}>"
+      end
+      
+      protected
+      
+      def self.sinatra_root
+        ::Sinatra::Application.root
+      end
+      
+      def self.sinatra_environment
+        ::Sinatra::Application.environment
+      end
+      
+      def to_attributes(options)
+        options.map {|k, v| "#{k}='#{v}'"}.join(' ')
+      end
+      
+    end
+  end
+end

data/lib/simple_navigation/adapters.rb

@@ -0,0 +1,9 @@
+require 'simple_navigation/adapters/base'
+
+module SimpleNavigation
+  module Adapters
+    autoload :Rails, 'simple_navigation/adapters/rails'
+    autoload :Padrino, 'simple_navigation/adapters/padrino'
+    autoload :Sinatra, 'simple_navigation/adapters/sinatra'
+  end
+end

data/lib/simple_navigation/core/configuration.rb

@@ -0,0 +1,70 @@
+require 'singleton'
+
+module SimpleNavigation
+
+  # Responsible for evaluating and handling the config/navigation.rb file.
+  class Configuration
+    include Singleton
+
+    attr_accessor :renderer, :selected_class, :autogenerate_item_ids, :id_generator, :auto_highlight
+    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'
+      @autogenerate_item_ids = true
+      @id_generator = Proc.new {|id| id.to_s }
+      @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