@@ -1,62 +1,62 @@ -AgileMantisNavigation -===================== - -Site navigation via Controller Class Methods and one helper tag. No config files or hassling with mulitple links sprinkled across many views. -Sample controllers and CSS file included. - -Features: -1 - Sort order, explicit or default of alphabetic. -2 - Security to determine (at time of render, not during app load), if a link should be rendered or not. -3 - Support for different css when user is "on" one of the page links (e.g. to remove underline, bold, change tab background, change hover, etc.) -4 - Visual seperators, or not, your choice (html or text) -5 - Support of 'link_to' helper, with both 'options' and 'html_options' -6 - Simple link definitions, if desired, or complex definitions. -7 - Auto discovery of links via Controller Class Methods upon initializaiton, no config files. -8 - Links defined in the controllers, a logical place to manage actions and their links. -9 - Support for Namespace Controllers - -Examples -======== - -# Example: A simple link to the Gallery controler, index view: -def self.agile_mantis_navigation_primary - { :name => 'Our Gallery' } -end - -# Produces: -<div class="agile_mantis_navigation"><ul><li><a href="/gallery">Our Gallery</a></li></ul></div> - -# If the Browser is 'on' the view, the link looks like: -<a href="/gallery" class="on">Our Gallery</a> - -# Example: Multiple links, via an Array. Explicit sort order and view definition: -def self.agile_mantis_navigation_primary - links = Array.new - links << { :name => 'About Us', :sort_order => 1, :link_to_options => { :action => 'about' } } - links << { :name => 'Terms & Conditions', :sort_order => 99999, :link_to_options => { :action => 'terms' } } -end - -# Security example: -def self.link_allowed_method - true # Or custom logic -end - -def self.agile_mantis_navigation_primary - { :name => 'Admin Page', :permission => :link_allowed_method } -end - - - -Installation -============ -1) Drop plugin in plugins folder -2) Add helper tag to layout: - - No separator: <%= agile_mantis_navigation_links %> - - Separator: <%= agile_mantis_navigation_links(" | ") %> Replace pipe with text or html -3) Add CSS tags for a custom look/feel (see sample_app\public\stylesheets\agile_mantis_navigation.css for examples and tag names) -4) To override default sort order and use the :sort_order option, add the following to environment.rb - AGILE_MANTIS_NAVIGATION_PRIMARY_SORT_ORDER = :use_sort_order_symbol -5) Add links to controller methods self.agile_mantis_navigation_primary - - -Copyright (c) 2009 [Ledsworth Consluting LLC], released under the MIT license +AgileMantisNavigation +===================== + +Site navigation via Controller Class Methods and one helper tag. No config files or hassling with mulitple links sprinkled across many views. +Sample controllers and CSS file included. + +Features: +1 - Sort order, explicit or default of alphabetic. +2 - Security to determine (at time of render, not during app load), if a link should be rendered or not. +3 - Support for different css when user is "on" one of the page links (e.g. to remove underline, bold, change tab background, change hover, etc.) +4 - Visual seperators, or not, your choice (html or text) +5 - Support of 'link_to' helper, with both 'options' and 'html_options' +6 - Simple link definitions, if desired, or complex definitions. +7 - Auto discovery of links via Controller Class Methods upon initializaiton, no config files. +8 - Links defined in the controllers, a logical place to manage actions and their links. +9 - Support for Namespace Controllers + +Examples +======== + +# Example: A simple link to the Gallery controler, index view: +def self.agile_mantis_navigation_primary + { :name => 'Our Gallery' } +end + +# Produces: +<div class="agile_mantis_navigation"><ul><li><a href="/gallery">Our Gallery</a></li></ul></div> + +# If the Browser is 'on' the view, the link looks like: +<a href="/gallery" class="on">Our Gallery</a> + +# Example: Multiple links, via an Array. Explicit sort order and view definition: +def self.agile_mantis_navigation_primary + links = Array.new + links << { :name => 'About Us', :sort_order => 1, :link_to_options => { :action => 'about' } } + links << { :name => 'Terms & Conditions', :sort_order => 99999, :link_to_options => { :action => 'terms' } } +end + +# Security example: +def self.link_allowed_method + true # Or custom logic +end + +def self.agile_mantis_navigation_primary + { :name => 'Admin Page', :permission => :link_allowed_method } +end + + + +Installation +============ +1) Drop plugin in plugins folder +2) Add helper tag to layout: + - No separator: <%= agile_mantis_navigation_links %> + - Separator: <%= agile_mantis_navigation_links(" | ") %> Replace pipe with text or html +3) Add CSS tags for a custom look/feel (see sample_app\public\stylesheets\agile_mantis_navigation.css for examples and tag names) +4) To override default sort order and use the :sort_order option, add the following to environment.rb + AGILE_MANTIS_NAVIGATION_PRIMARY_SORT_ORDER = :use_sort_order_symbol +5) Add links to controller methods self.agile_mantis_navigation_primary + + +Copyright (c) 2009 [Ledsworth Consluting LLC], released under the MIT license plugins/agile_mantis_navigation/README @@ -1,60 +1,60 @@ -require 'application.rb' -class AgileMantisNavigation - - attr_accessor :primary_sort_order - - def initialize(rails_root,sort_order=nil) - if sort_order - self.primary_sort_order = sort_order - else - self.primary_sort_order = :name - end - @primary_links = [] - Dir["#{RAILS_ROOT}/app/controllers/**/*_controller.rb"].entries.each do |controller| - capture_links(controller.gsub(".rb","").gsub("#{RAILS_ROOT}/app/controllers/","").camelize) - end - sort_primary - end - - def capture_links(controller) - (eval("#{controller}.methods")).sort.each do |method| - if method == "agile_mantis_navigation_primary" - am_links = eval("#{controller}.agile_mantis_navigation_primary") - if am_links - add_primary(controller,am_links) - end - end - end - end - - def add_primary(controller,am_links) - am_links = [am_links] unless am_links.kind_of?(Array) - am_links.each do |am_link| - controller_path = "/" + eval("#{controller}.controller_path") # namespace controllers require leading / for link_to to work - if am_link[:link_to_options] - am_link[:link_to_options]=am_link[:link_to_options].merge({ :controller => controller_path }) - else - am_link=am_link.merge({:link_to_options=>{ :controller => controller_path }}) - end - # Ensure :sort_order exists if primary sort order symbol is the sort order, so sort_primary doesn't error - if primary_sort_order == :use_sort_order_symbol && !am_link[:sort_order] - am_link=am_link.merge({ :sort_order => 1 }) - end - am_link[:controller] = controller - @primary_links << am_link - end - end - - def sort_primary - if primary_sort_order == :use_sort_order_symbol - @primary_links = @primary_links.sort_by { |am_link| am_link[:sort_order] } - return - end - @primary_links = @primary_links.sort_by { |am_link| am_link[:name] } - end - - def primary - @primary_links - end - +require 'application.rb' +class AgileMantisNavigation + + attr_accessor :primary_sort_order + + def initialize(rails_root,sort_order=nil) + if sort_order + self.primary_sort_order = sort_order + else + self.primary_sort_order = :name + end + @primary_links = [] + Dir["#{RAILS_ROOT}/app/controllers/**/*_controller.rb"].entries.each do |controller| + capture_links(controller.gsub(".rb","").gsub("#{RAILS_ROOT}/app/controllers/","").camelize) + end + sort_primary + end + + def capture_links(controller) + (eval("#{controller}.methods")).sort.each do |method| + if method == "agile_mantis_navigation_primary" + am_links = eval("#{controller}.agile_mantis_navigation_primary") + if am_links + add_primary(controller,am_links) + end + end + end + end + + def add_primary(controller,am_links) + am_links = [am_links] unless am_links.kind_of?(Array) + am_links.each do |am_link| + controller_path = "/" + eval("#{controller}.controller_path") # namespace controllers require leading / for link_to to work + if am_link[:link_to_options] + am_link[:link_to_options]=am_link[:link_to_options].merge({ :controller => controller_path }) + else + am_link=am_link.merge({:link_to_options=>{ :controller => controller_path }}) + end + # Ensure :sort_order exists if primary sort order symbol is the sort order, so sort_primary doesn't error + if primary_sort_order == :use_sort_order_symbol && !am_link[:sort_order] + am_link=am_link.merge({ :sort_order => 1 }) + end + am_link[:controller] = controller + @primary_links << am_link + end + end + + def sort_primary + if primary_sort_order == :use_sort_order_symbol + @primary_links = @primary_links.sort_by { |am_link| am_link[:sort_order] } + return + end + @primary_links = @primary_links.sort_by { |am_link| am_link[:name] } + end + + def primary + @primary_links + end + end \ No newline at end of file plugins/agile_mantis_navigation/lib/agile_mantis_navigation.rb @@ -1,19 +1,19 @@ -/* Agile Mantis Navigation */ -DIV.agile_mantis_navigation ul{ - margin: 0; - padding: 0; -} -DIV.agile_mantis_navigation li { - list-style-type: none; - float: left; - text-align: center; - padding-right: 8px; -} -DIV.agile_mantis_navigation a { - color: #555555; - text-decoration: underline; -} -DIV.agile_mantis_navigation a.on { - color: #ff0000; - text-decoration: none; +/* Agile Mantis Navigation */ +DIV.agile_mantis_navigation ul{ + margin: 0; + padding: 0; +} +DIV.agile_mantis_navigation li { + list-style-type: none; + float: left; + text-align: center; + padding-right: 8px; +} +DIV.agile_mantis_navigation a { + color: #555555; + text-decoration: underline; +} +DIV.agile_mantis_navigation a.on { + color: #ff0000; + text-decoration: none; } \ No newline at end of file plugins/agile_mantis_navigation/sample_app/public/stylesheets/agile_mantis_navigation.css @@ -1,4 +1,4 @@ -Only the files used for testing and demonstration are included here. This is not a full rails app. - -Do not just copy this over an existing app, use for examples, demonostration, or for placing in a fresh +Only the files used for testing and demonstration are included here. This is not a full rails app. + +Do not just copy this over an existing app, use for examples, demonostration, or for placing in a fresh Rails app so plugin tests can be run if changes are being made. \ No newline at end of file plugins/agile_mantis_navigation/sample_app/readme.txt @@ -1,3 +1,3 @@ -Artist Index, with :action => 'index' in :link_to_options - +Artist Index, with :action => 'index' in :link_to_options + <a href="/artist/index">Artist, w/index in URI</a> \ No newline at end of file plugins/agile_mantis_navigation/sample_app/views/artist/index.rhtml @@ -1,15 +1,15 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html> - <head> - <title>Agile Mantis Navigation - Sample Application</title> - <%= stylesheet_link_tag 'agile_mantis_navigation', :media => "all" %> - <%= javascript_include_tag :defaults %> -</head> - <body> - <%= agile_mantis_navigation_links(" | ") %> - &nbsp;<p /> - <div> - <%= yield %> - </div> - </body> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> + <head> + <title>Agile Mantis Navigation - Sample Application</title> + <%= stylesheet_link_tag 'agile_mantis_navigation', :media => "all" %> + <%= javascript_include_tag :defaults %> +</head> + <body> + <%= agile_mantis_navigation_links(" | ") %> + &nbsp;<p /> + <div> + <%= yield %> + </div> + </body> </html> \ No newline at end of file plugins/agile_mantis_navigation/sample_app/views/layouts/application.rhtml @@ -8,9 +8,6 @@ require File.dirname(__FILE__) + '/../../../../config/environment.rb' class AgileMantisNavigationTest < Test::Unit::TestCase - def setup - end - def test_with_no_sort_order_specified @agm = AgileMantisNavigation.new(RAILS_ROOT,nil) assert_nil primary_sort_order_in_environment, "This test should not have AGILE_MANTIS_NAVIGATION_PRIMARY_SORT_ORDER set in environment.rg" plugins/agile_mantis_navigation/test/agile_mantis_navigation_test.rb 242b9191f4fecb4c4a816e1126a03521ff34310f Brian Ledsworth brian@ledsworth.com http://github.com/AgileMantis/agile-mantis-navigation/commit/ad63e77e390bc77c419fd53923ac1e70ca0428cc ad63e77e390bc77c419fd53923ac1e70ca0428cc 2009-03-18T19:22:18-07:00 2009-03-18T19:22:18-07:00 Removed empty setup method from test 6e6cbad4bc7065f0ce5f21bba0f049e3a7740fe3 Brian Ledsworth brian@ledsworth.com