rocknrollmarc / sinatra-simple-navigation

A Sinatra extension to enable creating navigations with the simple-navigation gem. Also works for Padrino.

sinatra-simple-navigation

sinatra-simple-navigation is a sinatra extension enabling the use of the simple-navigation gem in your sinatra and padrino applications.

Installation

Either manually install the gem

gem install sinatra-simple-navigation

or preferably use bundler and add it to your Gemfile

gem 'sinatra-simple-navigation'

and run bundle install

Usage

Sinatra Applications

Classic Style

To use simple-navigation in your classic style sinatra application, just require ‘sinatra/simple-navigation’:

require 'rubygems'
require 'sinatra'
require 'sinatra/simple-navigation'

# Your app code goes here

Modular Style

If you’re developing a module style sinatra application (i.e. subclassing Sinatra::Base), you have to register Sinatra::SimpleNavigation:

require 'rubygems'
require 'sinatra/base'
require 'sinatra/simple-navigation'

class MyApp < Sinatra::Base
  register Sinatra::SimpleNavigation
  
  # Your app code goes here
end

Padrino Applications

Using simple-navigation in your padrino application is similar to the modular sinatra style. In your app/app.rb file:

require 'sinatra/simple-navigation'

class MyApp < Padrino::Application
  register Sinatra::SimpleNavigation
  
  # Your app code goes here
end

Instead of requiring sinatra/simple-navigation at the top of the file, you could add this to your Gemfile:

gem 'sinatra-simple-navigation', :require => 'sinatra/simple-navigation'

Resources

• simple-navigation source code: http://github.com/codeplant/simple-navigation
• simple-navigation wiki: http://wiki.github.com/codeplant/simple-navigation
• demo project with sample applications for rails, sinatra and padrino: http://github.com/codeplant/simple-navigation-demo

Legal

Copyright © 2014 codeplant GmbH, released under the MIT license