codeplant/simple-navigation

A ruby gem for creating navigations (with multiple levels) for your Rails, Sinatra or Padrino applications. Render your navigation as html list, link list or breadcrumbs.

simple-navigation's Issues

Applying classes to the top level ul

I am probably overlooking something obvious here but I want to attach some classes to the generated ul elements and not the li. How do I do that? I wish to generate output that looks like

ul.menu
  li.selected
    ul.submenu.selected
      li
      li.selected
  li
  li
    ul.submenu
      li
      li

Invalid level specified or item key not found after updating to 3.0.0 (rails 2.3.5)

Hi,

I'm getting this error after updating from 2.7.1 to 3.0.0

Invocation (on a layout file):

= render_navigation(:context => :main)

I was expecting some kind of error, since my main_navigation.rb file does use the Database for getting nav items down (Page is a regular ActiveRecord model, and roots is just a named scope):

def main_menu_item(menu, pages)
  pages.each do |page|
    menu.item page.permalink, page.name, static_path(:permalink => page.permalink) do |sub_menu|
      main_menu_item(sub_menu, page.children.all(:order => 'pages.position ASC'))
    end
  end
end

SimpleNavigation::Configuration.run do |navigation|  
  navigation.items do |primary|
    main_menu_item(primary, Page.roots.all(:conditions => {:show_in_navigation => true}))
  end
end

Nevertheless, the 'level blahblablah' caught me off-guard. I don't have any idea of what it means.

The error is triggered by line 45 in /simple-navigation-3.0.0/lib/simple_navigation/rails_controller_methods.rb.

I went to that file and tried to understand what was happening, but the particular method that throws the error is pretty cryptic (indeed, there's a FIXME to make it "less ugly")

I tried several things and they didn't work out - at the end I just commented line 45, and the error seems to be gone. I doubt this is the correct way to solve the issue though.

4 Issues when running the rspec tests

Hey, I was looking at your code and decided to run the tests and there are 4 tests that fail:

SimpleNavigation config_file?
=> should check for the file existance with the file_name
=> should check for the file existance on default context

SimpleNavigation config_file? config file exists
=> should == {}

SimpleNavigation config_file? config file does not exist
=> should == {}

All of the errors are "can't convert nil into String"

Hope this helps you :-D

multiple highlights_on options of regexp

Dears,

kindly, is there a way to set multiple options for highlights_on like :
:highlights_on => [//post/,//posts/,//articles/]

Thanks,

data-confirm in url?

Hi Andi, thank you for the awesomely simple-navigation gem!

Wondering if I'm doing something wrong here. I have a menu item:
primary.item :profile, "Sign Out", destroy_user_session_path

and I'm trying to get a confirmation to pop up. When I add:
primary.item :profile, "Sign Out", destroy_user_session_path, :method => :delete

the appropriate data-method="delete" is added to the link. However, when I add:
primary.item :profile, "Sign Out", destroy_user_session_path, :confirm => "Logout?"

a confirm attribute is instead added to the li tag. Any idea how to get it to add a data-confirm="Logout?" to the link?

Thanks!

Item class conflict in production

Hello, thanks for a powerful plugin. I have experienced one problem:
I have a model named Item. In development environment everything worked fine but when deployed code to production I got an error:

/usr/lib/ruby/gems/1.8/gems/simple-navigation-1.4.0/lib/simple_navigation/item_container.rb:33:in `initialize': wrong number of arguments (5 for 1)

Looks like SimpleNavigation::Item is not loaded automatically therefore it tries to use my Item model there.

I added rails initializer to force loading of SimpleNavigation::Item, but that's a workaround. I suggest loading all required classes in plugin's init.rb.

trying to make simple-navigation work

Hi,
we are trying to implement your great menu idea.
But, anything we do, we get:
Showing app/views/layouts/pruebaas.html.erb where line #11 raised:
undefined local variable or method `render_navigation' for #ActionView::Base:0x506d080
Extracted source (around line #11):
8: <%= stylesheet_link_tag 'scaffold' %>
9:
10:
11: <%= render_navigation %>
12:

<%= flash[:notice] %>

.......
I read a message to you with the same problem, but no feedback from the issuer.
Could you please, help us?.. What we have done:

1. I had installed the 2.2.2 version of your gem (just as a gem, not a plugin)
2. I used the same block of code as your example “SimpleNavigation::Configuration.run do |navigation|
   navigation.items do |primary|

    primary.item :books, 'Books', session_path

.........
into navigation.rb
3. I’d put the require ‘simple_navigation’ at the end of: config\environment.rb, controllers\application_controller and controllers\pruebaas_controller.rb
We both are newies on ruby/rails.
Thanks a lot in advance!.

Can't use @template in controllers and views (Simple Navigation overrides it)

When I have a Template model (and use @template in my RESTful controllers and views), I get an error because SimpleNavigation overrides @template when the Rails adapter initializes. Not sure if this is a bug or simply a known issue, but it might be good to at least add a warning somewhere to avoid having this headache halfway through the development process.

Invalid level specified or item key not found

I updated to the new version and I got this error "Invalid level specified or item key not found". After debuging I noticed, that this is happening for this line:

primary.item :home, "Sākumlapa", home_url, :unless => Proc.new { logged_in?

But when I changed it to this, then it worked:

primary.item :home, "Sākumlapa", home_url unless logged_in?

Home controller looks:

class HomeController < ApplicationController
#navigation :home

def index
end

end

ps.

The error happens in simple_navigation.rb line 80, level == nil

files placement

Hi,
is it possible to add ability to place navigation's to the place, other that /config? for exampe to /config/navigations/ or /app/navigations/ :))

rspec 2 at rails3 tests fails with simple-navigation

Hi,
i have some configured navitations that located in app/navigations folder of my app. One of examples:

   navigation.selected_class = 'active'
   navigation.items do |primary|
    primary.dom_class = 'menu'
     primary.item :admin_dashboard, 'Dashboard', admin_dashboard_url
   end

Everything works fine, but any rspec tests fails with error
C:/Documents/Projects/myapp/app/navigations/admin_navigation.rb:61: undefined local variable or method admin_dashboard_url' for main:Object (NameError) from C:/Ruby/lib/ruby/gems/1.8/gems/simple-navigation-3.0.2/lib/simple_navigation/core/configuration.rb:57:incall'
from C:/Ruby/lib/ruby/gems/1.8/gems/simple-navigation-3.0.2/lib/simple_navigation/core/configuration.rb:57:in `items'

How to solve this problem?

URL matching with anchors doesn't work in rails

If my item's url in navigation.rb has an anchor in it, it appears to never match as active.

I'm wondering if SimpleNavigation::Item::selected_by_url? should strip the anchor from the item's URL before making the comparison? The request's current URL will never have an anchor in it.

I know I could use a highlights_on regexp to work around this, but I thought I'd point it out...

PS. Thanks for the lovely plugin!

simple-navigation not showing breadcrumb on first page visit

We are using Rails 3.1.0.rc1 and ruby 1.9.2 p180 . We have configured navigation.rb as followed:
primary.item :user, current_user.name.blank? ? 'Home' : current_user.name, root_path, :if => Proc.new { current_user.present? } primary.item :dimension, Dimension.breadcrumb_name(params[:dimension_id]), root_path(:dimension_id => params[:dimension_id]), :if => Proc.new{params[:dimension_id].present?}
And render breadcrumbs with:
= render_navigation :renderer => :breadcrumbs, :join_with => " > "

When we first visit the page, there's no breadcrumbs. If we click something that trigger the breadcrumbs to change (deeper level) then it appears, and then we can see the top level breadcrumbs if we visit the first page again.

Any help is appreciated

Highlighting with selected

Currently, highlighting with selected happens on the LI element, but I would like to have that added to the A element inside the LI,

Is this possible?
Also, is it possible to change the name from selected to say Active?

thanks

sinatra-simple-navigation: modular style apps should not require 'sinatra' in config.ru

modular style apps in sinatra currently only seem to work if

require 'sinatra'

is present in config.ru. If sinatra is not required then Sinatra::Application.root is not being set and SimpleNavigation.set_env fails because the root is nil.

Modular style apps should not require 'sinatra' but only 'sinatra/base'...

How to add target="_blank" to an <a> inside a <li>

Hi, is it possible to add html attributes to the tag within the

with the default renderer?
Ex:

Define the primary navigation

navigation.items do |primary|
primary.item :item1, 'Item 1', "/item/1", :target=>"_blank"
end

generates:

Item 1

I'm looking for a way to generate:

Item 1

FEATURE REQUEST: add "title" attribute to navigation anchors

Error handling for configuration files

Hello,

I have noticed a problem with error handling in simple-navigation config files.

First example:

I have the code:
...
primary.item :login, t(".login"), login_path, :if => lambda { current_userZZZ.nil? }
...

I have made mistake and type undefined method which return current user object. Then I reload page and don't see menu (only two UL tags). Application log doesn't have messages about error also.

Example 2:

I have the code:
...
primary.item :login, t(".login"), login_path, :if => lambda { current_user.has_role?(:admin) }
...

If current_user equal nil I don't see error message about this problem and I don't see menu (only two UL tags in HTML markup)

I think it isn't clear behavior. Could you please improve error handling in configuration files?

Thanks

Rails 2.3.5
simple-navigation 2.2.2

Breadcrumbs Renderer: do not render last crumb as link

The last item of the breadcrumbs should not be rendered as link. This should be the default-behaviour. It should be possible to override this in the options.

Edit resource link does not work in Rails 3

Some example menu code:
primary.item :projects, Project.model_name.human, projects_path do |sub_projects|
sub_projects.item :edit_project, "Edit project", "/projects/2/edit"
end

2nd level menu item would never be shown. But if I change the link to just "/projects/2" without "/edit" it became visible.
Think there is some unneccessary logic in menu rendering.

Active sublevels

Hello, I have simple first level item "/events/" and then sub level "/events/list/", but when I start paging the list like "/events/list/2" then the second level looses it's current item class. In routes I have /events/list/:page.

thanks in advance.

allow a callback to run against item Names

hey Andi,

Using SN yet again, and this time I'd really like to wrap my items in some other text. Right now I can do something ugly like

https://gist.github.com/c2afb6b16358f64973f9

but it'd be much nicer to just specify a callback. Could also used to tie into I18n easily rather than multiple calls.

It seems like this would be easy to patch and I'd be happy to do it if i'm not missing an already easy way to do this without creating my own renderer.

Hope you're well!

Jack

Using simple-navigation gem in Rails 3 to display proper submenu on render :create.

Hello

Cross-posting here from stackoverflow :

nobody seems to know there - I barely got 8 views :-( You can skip to edit section, that's my current solution, but I'm not sure that is a proper way to do it using this gem.

I'm using simple-navigation gem in my Rails 3 app. It works fine except for one little quirk.

I have a sidebar div that contains a second level of menu, that get's displayed !render_navigation(:level => 2).nil?

It works fine except in one special case. Let's say I have a model ContactAttempt. A regular user (even if they are not signed in) is able to create a new ContactAttempt , in controller I save the record and then a notification email is sent to an appropriate department.
Also an admin is able to list all records (index) and look at each one ( show), edit and update are disabled. This is just a contact form there is no need to edit or update records for other than malicious reasons.

Here is how my navigation is setup right now ( from navigation.rb)

primary.item :contact_us, 'Contact Us', new_contact_attempt_path do |secondary|
  secondary.item :send_email, 'Send Email', new_contact_attempt_path
  if user_signed_in? and current_user.admin?
    secondary.item :list_contact_attempts, 'List of Contact Attempts', contact_attempts_path 
  end  
end  

My problem is that when user tries to submit info that doesn't pass validation (like without return email, or message containing illegal characters) the form is rendered again with all the error indicated. However even thou the current_action == "create" , the actual url becomes "localhost:3000/contact_attempts . Which means that to simple- navigation it looks like the path is contact_attempt_path , and secondary.item :new_contact_attempt is not generated. I tried to solve it using highlights_on => /contact_attempts which forces item to get generated on all views but then it highlights all the time on all actions - which is confusing.

Does anyone have any idea how to solve it?

EDIT

Ok I was able to figure out a way to achieve what I want - but it seems cumbersome, and I don't really like it:

primary.item :contact_us, 'Contact Us', new_contact_attempt_path do |secondary|
  if user_signed_in? and current_user.admin?
    if params[:action] == ("create" or "new" )
      secondary.item :send_email, 'Send Email', new_contact_attempt_path, :highlights_on => /contact_attempts/ 
      secondary.item :list_contact_attempts, 'List of Contact Attempts', contact_attempts_path, :highlights_on => /contact_attempts\/index/
    else
      secondary.item :send_email, 'Send Email', new_contact_attempt_path
      secondary.item :list_contact_attempts, 'List of Contact Attempts', contact_attempts_path
    end  
  else
    secondary.item :send_email, 'Send Email', new_contact_attempt_path, :highlights_on => /contact_attempts/   
  end  
end 

Thank you!

Also I read about the controller methods navigation and current_navigation, but in the faq it states that's it's not a recommended way of doing it, so I fear they might be eventually deprecated.

breadcrumbs and CRUD

First off; great gem!

I'm relatively new to Rails and Ruby so please forgive my ignorance. I'm using simple-navigation to render breadcrumbs. I having trouble specifically with crumbing for CRUD; specifically with SHOW and EDIT. I cant seem to get the path helpers to recognize the record ID for the notifications table.

Render line in app/views/layouts/application.html.erb

---

<%= render_navigation :renderer => :breadcrumbs, :join_with => " > " %>

navigation.rb:

---

SimpleNavigation::Configuration.run do |navigation|

navigation.items do |primary|

primary.item :home, 'Home', '/' do |home|
  home.item :notification, 'Portal Notifications', notifications_path do |notify|
    notify.item :notification, 'New Notification', new_notification_path
    notify.item :notification, 'Show Notification', notification_path(id)
    notify.item :notification, 'Edit Notification', edit_notification_path(id)
  end
end

end
end

Error:

---

undefined local variable or method `id'

Thanks for any help!

feature request: start render_navigation from a given level

E.g. you have a horizontal navigation with primary items and want the second level navigation appear on a completely different position in your layout, something like

render_navigation :entry_level => 1

and/or

render_navigation :depth => 1

would be nice.

Use link_to_unless_current instead of link_to

Is there a way that the render method uses a "link_to_unless_current" instead of a link_to? That way I won't get a link in the current page I'm on.

Thanks,

Nicolas Hock

navigations files in config/navigations

Dears,

kindly, in my project i have more than one navigation files. and i'd like to suggest changing the default path of from /config to /config/navigations to have a specific folder for navigations.

Best Regards,
Shenouda Bertel

:if and :unless procs should be evaluated before the url is

I have several nested routes, each with a navigation item.

It's currently not possible to use :if or :unless procs to prevent them from being rendered, because the URL is evaluated first, which fails.

For example:

primary.item :payments, 'Payments', business_payments_path, :if => Proc.new { params[:business_id] }

This navigation item should only appear when the current URL is /businesses/:business_id/*. I get a ActionController::RoutingError because of missing parameters - this might be avoided if the specified proc was evaluated before the route is.

I've poked into the source code and it does seem to be evaluating these procs first - see item_container.rb lines 38 and 44, calling should_add_item?. But maybe I'm reading the code wrong.

Version: simple-navigation 2.7.3

Questions about Plugin.

Sorry to put this in issues. I am using your gem and i really like it.

My issue is, I want to move level 2 navigation to its own box. So I need to test render_navigation(:level => 2) to see if it has something init, if I do that I can suppress all the layout that I put around the layer two ul and li's.

Can you show me how to test for length?

option to overwrite id and class when render breadcumb

i use somthign like:

primary.dom_id = 'main'
primary.dom_class = 'menu'

it will be nice to overwrite it when render as breadcumb.

Simple_navigation on the same page does not works

Hey,

What we have:

• rails 3 beta 4
• ruby 1.8.7 (2009-06-12 patchlevel 174) [i686-darwin9.8.0], MBARI 0x8770, Ruby Enterprise Edition 2009.10
• simple-navigation (2.6.0)
• two configuration files

  # config/initializers/simple_navigation.rb
  SimpleNavigation.config_file_path = File.join(Rails.root, 'config', 'navigations')
  

config/navigations/main_navigation.rb

SimpleNavigation::Configuration.run do |navigation|
navigation.selected_class = 'current'
navigation.autogenerate_item_ids = false

navigation.items do |primary|
primary.item :units, 'Units', units_path
primary.item :depot, 'Depot', on_depot_units_path
primary.item :rooms, 'Rooms', rooms_path
primary.item :users, 'Users', users_path
end
end

config/navigations/user_navigation.rb

SimpleNavigation::Configuration.run do |navigation|
navigation.selected_class = 'current'
navigation.autogenerate_item_ids = false

navigation.items do |user|
user.item :account, 'My Account', edit_user_registration_path
user.item :sign_out, 'Sign out', destroy_user_session_path
end
end

layout

<%= render_navigation(:context => :main) %> <%= render_navigation(:context => :user) %>

But only first menu rendered.

Thanks,
Timur

sn_set_navigation method has public visibility

Hello,

I have noticed that sn_set_navigation method has public visibility because I see error page:

Unknown action
No action responded to show. Actions: create, destroy, edit, index, new, sn_set_navigation, and update

I think it is better to decrease visibility to private.

Thanks

I18n inside navigation.rb (version 3.0.0)

Cannot use t(".dashboard") shortcut because path is not available

This is the error message I get when I'm using i18n inside navigation.rb

primary.item :dashboard, t(".dashboard"), backend_dashboard_path, :class => 'level-1'

current_page? for renderers

Hi, first of all, thanks for the great gem Andi

I've got a minor feature request, I would like if we could use the current_page? option from the adapter classes.

Thomas

How do I add labels on github?

Appending content to a menu item?

If I have a menu outputting like

< div>
< ul>
< li>
< a href="titleID"> Title from config file< /a>
< /li>
< /ul>
< /div>

How can I append html like follows in the navigation.rb config file?

< div>
< ul>
< li>
< a href="titleID"> Title from config file< /a>
< div>lots of code appended here to allow for a popup dialog with abs positioning< /div>
< /li>
< /ul>
< /div>

Is this supported? please say yes, this looks like a killer plugin and I hope to use it!

Auto-highlighting for 2.5.0

Hi, we are using the 2.5.0 version of the gem under rails3beta3.

We have a single level navigation with all of the links rendered by a single controller. However, the auto-highlight is not applying for the appropriate action. We are not passing dynamic params into the actions.

If we remove auto-highlighting and use explicit highlighting with current_navigation then everything works as intended.

One other thing of note is that for this particular controller, our routes are not setup using resources but as matches. For example,
match '/account/password' => 'accounts#password', :as => :password

I think I missed something. Please help with this error

routes.rb

PASFramework::Application.routes.draw do |map|

  resources :users do
    collection do
      get :index
      get :edit
      post :update
      get :show
  end
 end

  root :to => 'users#index'

end

navigation.rb



# Configures your navigation

SimpleNavigation::Configuration.run do |navigation|
  navigation.items do |primary|
    primary.item :users, 'Welcome User', root_path do |users|
      users.item :edit, 'Edit Profile', edit_users_path
    end
  end

end

User_controller

class UsersController < ApplicationController
  def index
    user = current_facebook_user.fetch
    @u = User.find_by_facebook_id(user.id)
    if @u.nil?
      @u = User.find_or_create_by_facebook_id(user.id)
      @u.update_attributes( :first_name => current_facebook_user.first_name,
                        :last_name => current_facebook_user.last_name )
      gflash :notice => "Welcome, #{current_facebook_user.name} "
    else
      gflash :notice => "Welcome back, #{current_facebook_user.first_name} #{current_facebook_user.last_name}"
    end
    return

    rescue Exception
      logger.info "Problem"
      logger.error($!)
      top_redirect_to auth_url
  end

def show
end

  def edit
    user = current_facebook_user.fetch
    @user = User.find_all_by_facebook_id(user.id)
  end

  def update
    user = current_facebook_user.fetch
    @user = User.find_all_by_facebook_id(user.id)
    if @user.update_attributes(:first_name => params[:first_name],
                            :last_name => params[:last_name])
      redirect_to user_path, :notice => t('users.update_success')
    else
      render :action => 'edit'
    end
  end

end

The menu is created really well and thanks for this awesome plugin. But when I click edit user I get an error:

ActionView::Template::Error (No route matches {:action=>"show", :controller=>"users"}):

Can someone help me with that please? Can someone explain me why in routes.rb resources user only is not working instead of the collection thing?

Thanks in advance.

undefined root_path

I'm getting the following error:

undefined local variable or method `root_path' for ActionController::Base:Class

In fact, none of my named routes are working within the navigation.rb config file. This started happening after I upgraded to ruby 1.9.2. Could this be the issue? Is this gem 1.9 ready?

How to test if a navigation context have items ?

Hello,
In views I would to test if any items in a context navigation exists.
How to test if a navigation context have items ?
Thanks.

Generate two different navigations

Dears,

i'm new to simple-navigation, i'd like to ask how to generate 2 different and separately navigations
which will be used in different layouts.

Thanks,
Shenouda Bertel

highlight on empty request_uri

I'm trying to get a link to be highlighted when request_uri returns "/" (i.e. when there is only the website url www.mysite.com instead of www.mysite.com/page).

I'm using v3.2.0 and tried the following:

page_attributes[:highlights_on] = /^\/$/

I logged the request_uri and it shows "/", I also logged the generated hashes for my dynamic navigation and it returns:

[{:key=>1, :name=>"homepage", :url=>"/homepage", :highlights_on=>/^\/$/}, {:key=>2, :name=>"contact", :url=>"/contact"}]

So as you can see, "homepage" should highlight on "/" but it doesn't, the rest (auto-highlighting) works as expected "homepage" is highlighted on "/homepage" and "contact" is highlighted on "/contact".

Any thoughts?

Navigation, Regex for adding selected to a HASH

Hello,

I'm adding deep linking to an app and am curious how to regex for a HASH?

example:

//feed/ --- Works great for http://localhost/feed/

//feed/ --- Does NOT work for http://localhost/#/feed/
//feed/ --- Does NOT work for http://localhost/#/feed/3/
etc...

Tried
//#/feed/ but that does't seem to work. Any RegEx experts able to help? thxs

(private method `split' called for :login:Symbol)

(private method `split' called for :login:Symbol)

Causes on
primary.item :login, "Login", :login
last param can be symbol :login, not only login_path

Using dynamic items and current_navigation methods

We are building out the menu tree with a database powered model.
Keys are being populated as well.

Is it possible to use the current_navigation method when feeding the items to simple navigation?

When rending SubNavs with AJAX, is there a way to specify the URL

Hello, I'm building a web app and the SubNav is dynamic based on the user which requires an AJAX request to the server from time to time via a /navigation/getsubnav controller/partial...

In that partial, is there a way to return:
render_navigation(:level => 3)

and some how specific for what item I need the items for ?
Example:
Books
-- New
-- Old
Music
Art

I'd like to be able to set the request to say get me the navigation L=2 for Books....

Thanks!

Dynamically Displaying a navigation item if a param is defined in the URL

For the app I'm working on I have projects

http://localhost/#/projects/
http://localhost/#/projects/3/
http://localhost/#/projects/3/stuff
http://localhost/#/projects/3/stuff/1

ETC... In the case when 3 is defined, I'd like to add a navigation item to say what 3 is...

Example Output
Home
Projects

• PROJECT NAME

Is there a way with the navigation config to determine if a project id is defined (with or without a hash) and if found, then output a primary item?

Thanks!

Dynamic menus

I want to append some dynamically generated entries to a submenu. How do I do this with simple-navigation?

Edit: Hah! Just saw http://wiki.github.com/andi/simple-navigation/faq#q3 Mailed.

add helper to get the selected item's name for a specific level

Separators support

It would be nice if using your gem I can add separators (or groups) within menu elements, to do something like this:

SimpleNavigation::Configuration.run do |navigation|  
  navigation.items do |primary|
    primary.group 'label', :tag => :h2, :class => :menu  do
      primary.item :books, 'Books', books_path
      primary.item :music, 'Music', musics_path
      primary.item :dvds, 'Dvds', dvds_path
    end
  end
end

which would render this html

<h2 class="menu">label</h2>
<ul>
  <li>...</li>
  <li>...</li>
  <li>...</li>
</ul>

Add possiblity to set id and or class on navigation ul

Hi, I added the following code to allow the passing of an id and or class for the list ul. Could you implement this feature in your version ?

In item_container.rb

# The options are the same as in the view's render_navigation call (they get passed on)
def render(options={})
  self.dom_id = options[:id] if options.has_key? :id
  self.dom_class = options[:id] if options.has_key? :class

Cheers,

Ygor