tabnav 1.1.0 → 1.2.0

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gem
+.bundle
+Gemfile.lock
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in tabnav.gemspec
+gemspec

data/LICENSE

@@ -2,7 +2,7 @@ LICENSE
 
 The MIT License
 
-Copyright (c) 2010 Alex Tomlins and Unboxed Consulting
+Copyright (c) 2012 Alex Tomlins and Unboxed Consulting
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -42,6 +42,53 @@ On any action in FrooblesController will output:
 
 See the highlights_on method of Tabnav::Tab for full details of the highlighting logic.
 
+=== Nested navbars
+
+In your view:
+
+  <%
+    render_tabnav do |n|
+      n.add_tab do |t|
+        t.named "Home"
+        t.links_to root_path
+        t.highlights_on :controller => :home, :action => :index
+      end
+      n.add_sub_nav do |sn|
+        sn.named "Froobles"
+        sn.links_to froobles_path
+        sn.highlights_on :controller => :froobles
+
+        sn.add_tab do |t|
+          t.named "New Frooble"
+          t.links_to new_frooble_path
+          t.highlights_on :controller => :froobles, :action => :new
+          t.highlights_on :controller => :froobles, :action => :create
+        end
+
+        sn.add_tab do |t|
+          t.named "Search Froobles"
+          t.links_to search_froobles_path
+          t.highlights_on :controler => :froobles, :action => :search
+        end
+      end
+    end
+  %>
+
+On FrooblesController#new will output:
+
+  <ul>
+    <li><a href="/">Home</a></li>
+    <li class="active">
+      <a href="/froobles">Froobles</a>
+      <ul>
+        <li class="active"><a href="/froobles/new">New Frooble</a></li>
+        <li><a href="/froobles/search">Search Froobles</a></li>
+      </ul>
+    </li>
+  </ul>
+
+Navbars can be nested arbritarily deep.
+
 === Options for controlling markup
 
 View:
@@ -57,10 +104,14 @@ View:
         t.named "Froobles Heading"
         t.highlights_on :controller => :froobles
       end
-      n.add_tab do |t|
-        t.named "Froobles"
-        t.links_to froobles_path, :target => "_blank", :rel => "http://foo.bar/"
-        t.highlights_on :controller => :froobles, :action => :index
+      n.add_sub_nav :id => 'froobles' do |sn|
+        sn.named "Froobles"
+
+        sn.add_tab do |t|
+          t.named "All Froobles"
+          t.links_to froobles_path, :target => "_blank", :rel => "http://foo.bar/"
+          t.highlights_on :controller => :froobles, :action => :index
+        end
       end
     end
   %>
@@ -70,7 +121,12 @@ On froobles/index will output:
   <ul id="main_navigation" class="clearfix">
     <li class="home_tab"><a href="/">Home</a></li>
     <li class="heading active"><span>Froobles Heading</span></li>
-    <li class="active"><a href="/froobles" target="_blank" rel="http://foo.bar/">Froobles</a></li>
+    <li id="froobles">
+      <span>Froobles</span>
+      <ul>
+        <li class="active"><a href="/froobles" target="_blank" rel="http://foo.bar/">All Froobles</a></li>
+      </ul>
+    </li>
   </ul>
 
 === Custom tab partial
@@ -137,4 +193,4 @@ The concept for this is based on the tabnav component from rails_widgets: http:/
 
 == Copyright
 
-Copyright (c) 2010 Unboxed. See LICENSE for details.
+Copyright (c) 2012 Alex Tomlins and {Unboxed Consulting}[http://www.unboxedconsulting.com/]. See LICENSE for details.

data/Rakefile

@@ -1,38 +1,17 @@
-require 'rubygems'
-require 'rake'
+require 'bundler/gem_tasks'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "tabnav"
-    gem.summary = %Q{Rails helper for generating navbars}
-    gem.description = %Q{Rails helper for generating navbars in a declarative manner}
-    gem.email = "github@unboxedconsulting.com"
-    gem.homepage = "http://github.com/unboxed/tabnav"
-    gem.authors = ["Unboxed"]
-    gem.add_dependency "actionpack", ">= 2.3.8"
-    gem.add_development_dependency "rspec", "~> 2.6.0"
-    gem.add_development_dependency "rspec-rails", "~> 2.6.1"
-    gem.files.exclude "*.gemspec", '.gitignore', 'doc/*'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+$:.push File.expand_path("../lib", __FILE__)
+require "tabnav/version"
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "tabnav #{version}"
+  rdoc.title = "tabnav #{Tabnav::VERSION}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/doc/ideas/basic_flat_navbar.html.erb

@@ -0,0 +1,53 @@
+
+Flat Navbar:
+
+<%
+  render_tabnav do |n|
+    n.add_tab do |t|
+      t.named "Home"
+      t.links_to root_path
+      t.highlights_on :controller => :home, :action => :index
+    end
+    n.add_tab do |t|
+      t.named "Froobles"
+      t.links_to froobles_path
+      t.highlights_on :controller => :froobles
+    end
+  end
+%>
+
+On home/index outputs:
+
+<ul>
+  <li class="active"><a href="/">Home</a></li>
+  <li><a href="/froobles">Froobles</a></li>
+</ul>
+
+More markup options:
+
+<%
+  render_tabnav :id => "main_navigation", :class => "clearfix" do |n|
+    n.add_tab :class => "home_tab" do |t|
+      t.named "Home"
+      t.links_to root_path
+      t.highlights_on :controller => :home, :action => :index
+    end
+    n.add_tab :class => "heading" do |t|
+      t.named "Froobles Heading"
+      t.highlights_on :controller => :froobles
+    end
+    n.add_tab do |t|
+      t.named "Froobles"
+      t.links_to froobles_path, :target => "_blank", :rel => "http://foo.bar/"
+      t.highlights_on :controller => :froobles, :action => :index
+    end
+  end
+%>
+
+On froobles/index outputs:
+
+<ul id="main_navigation" class="clearfix">
+  <li class="home_tab"><a href="/">Home</a></li>
+  <li class="heading active"><span>Froobles Heading</span></li>
+  <li class="active"><a href="/froobles" target="_blank" rel="http://foo.bar/">Froobles</a></li>
+</ul>

data/doc/ideas/custom_tab partial.html.erb

@@ -0,0 +1,88 @@
+Custom partial for tab contents
+
+<%
+  render_tabnav :html => {:id => "main_navigation", :class => "clearfix"} do |n|
+    n.tab_partial "/shared/my_custom_tab"
+    n.add_tab :html => {:class => "home_tab"} do |t|
+      t.named "Home"
+      t.links_to root_path
+      t.highlights_on :controller => :home, :action => :index
+    end
+    n.add_tab :html => {:class => "heading"} do |t|
+      t.named "Froobles Heading"
+      t.highlights_on :controller => :froobles
+    end
+    n.add_tab do |t|
+      t.named "Froobles"
+      t.links_to froobles_path, :target => "_blank", :rel => "http://foo.bar/"
+      t.highlights_on :controller => :froobles, :action => :index
+    end
+  end
+%>
+
+in /app/views/shared/_my_custom_tab.html.erb:
+
+<div class="my_custom_class">
+  <%- if tab.has_link? -%>
+    <%= link_to tab.name, tab.url %>
+  <%- else -%>
+    <span><%= tab.name %></span>
+  <%- end -%>
+</div>
+
+On froobles/index outputs:
+
+<ul id="main_navigation" class="clearfix">
+  <li class="home_tab"><div class="my_custom_class"><a href="/">Home</a></div></li>
+  <li class="heading active"><div class="my_custom_class"><span>Froobles Heading</span></div></li>
+  <li class="active"><div class="my_custom_class"><a href="/froobles">Froobles</a></div></li>
+</ul>
+
+
+With nested menus:
+
+<%
+  render_tabnav do |n|
+    n.tab_partial "/shared/my_custom_tab"
+    n.add_tab do |t|
+      t.named "Home"
+      t.links_to root_path
+      t.highlights_on :controller => :home, :action => :index
+    end
+
+    n.add_sub_nav do |sn|
+      sn.named "Froobles"
+
+      sn.add_tab do |t|
+        t.named "All Froobles"
+        t.links_to froobles_path
+        t.highlights_on :controller => :froobles, :action => :index
+      end
+
+      sn.add_tab do |t|
+        t.named "New Frooble"
+        t.links_to new_frooble_path
+        t.highlights_on :controller => :froobles, :action => :new
+        t.highlights_on :controller => :froobles, :action => :create
+      end
+    end
+
+    n.add_tab do |t|
+      t.named "Something Else"
+      t.links_to "/somewhere"
+    end
+  end
+%>
+
+On the froobles index, outputs:
+
+<ul>
+  <li><div class="my_custom_class"><a href="/">Home</a></div></li>
+  <li><div class="my_custom_class"><span>All Froobles</span></div>
+    <ul>
+      <li class="active"><a href="/froobles">Froobles</a></li>
+      <li><a href="/froobles/new">New Frooble</a></li>
+    </ul>
+  </li>
+  <li><div class="my_custom_class"><a href="/somewhere">Something Else</a></div></li>
+</ul>

data/doc/ideas/nested_versions.html.erb

@@ -0,0 +1,47 @@
+
+Nested Manus:
+
+<%
+  render_tabnav do |n|
+    n.add_tab do |t|
+      t.named "Home"
+      t.links_to root_path
+      t.highlights_on :controller => :home, :action => :index
+    end
+
+    n.add_sub_nav do |sn|
+      sn.named "Froobles"
+
+      sn.add_tab do |t|
+        t.named "All Froobles"
+        t.links_to froobles_path
+        t.highlights_on :controller => :froobles, :action => :index
+      end
+
+      sn.add_tab do |t|
+        t.named "New Frooble"
+        t.links_to new_frooble_path
+        t.highlights_on :controller => :froobles, :action => :new
+        t.highlights_on :controller => :froobles, :action => :create
+      end
+    end
+
+    n.add_tab do |t|
+      t.named "Something Else"
+      t.links_to "/somewhere"
+    end
+  end
+%>
+
+On the froobles index, outputs:
+
+<ul>
+  <li><a href="/">Home</a></li>
+  <li><span>All Froobles</span>
+    <ul>
+      <li class="active"><a href="/froobles">Froobles</a></li>
+      <li><a href="/froobles/new">New Frooble</a></li>
+    </ul>
+  </li>
+  <li><a href="/somewhere">Something Else</a></li>
+</ul>

data/lib/tabnav.rb

@@ -1,3 +1,4 @@
+require 'tabnav/version'
 
 module Tabnav
 end

data/lib/tabnav/helper.rb

@@ -9,9 +9,9 @@ module Tabnav
     #
     # Finally, this renders the navbar, and concats the result into the view.
     def render_tabnav(options = {})
-      n = Navbar.new(self, params, options)
+      n = Navbar.new(self, params, options.merge(:top_level => true))
       yield(n)
-      concat( n.render )
+      concat( n.render_navbar )
       nil
     end
   end

data/lib/tabnav/navbar.rb

@@ -1,10 +1,10 @@
 module Tabnav
-  class Navbar
-    def initialize(template, params, options = {}) # :nodoc:
-      @template = template
-      @params = params
-      @html_options = options
+  class Navbar < Tab
+    def initialize(template, params, html_options = {}) # :nodoc:
+      @top_level = html_options.delete(:top_level)
+      super
       @tabs = []
+      @tab_content_partial = @partial
     end
 
     # Optionally specifies a partial to be used to render the tab content.
@@ -15,16 +15,22 @@ module Tabnav
     # +options+ is an optional hash of options which will be used to create the +li+ for the tab.
     #
     # yields the created Tab
-    def add_tab(options = {})
-      options[:tab_content_partial] = @tab_content_partial if @tab_content_partial
-      t = Tab.new(@template, @params, options)
-      yield t
-      @tabs << t
+    def add_tab(options = {}, &block)
+      add_item(Tab, options, &block)
+    end
+
+    # Creates a sub Navbar and adds it to the navbar.
+    #
+    # +options+ is an optional hash of options which will be used to create the +li+ containing the sub navbar.
+    #
+    # yields the created Navbar
+    def add_sub_nav(options = {}, &block)
+      add_item(Navbar, options, &block)
     end
 
-    def render # :nodoc:
-      return '' if @tabs.empty?
-      @template.content_tag :ul, @html_options do
+    def render_navbar # :nodoc:
+      return ''.html_safe if @tabs.empty?
+      @template.content_tag :ul, @top_level ? @html_options : nil do
         contents = ''.html_safe
         @tabs.each do |tab|
           contents << tab.render
@@ -32,5 +38,18 @@ module Tabnav
         contents
       end
     end
+
+    private
+
+    def add_item(klass, options)
+      options[:tab_content_partial] = @tab_content_partial if @tab_content_partial
+      i = klass.new(@template, @params, options)
+      yield i
+      @tabs << i
+    end
+
+    def render_tab
+      super + render_navbar
+    end
   end
 end

data/lib/tabnav/tab.rb

@@ -2,6 +2,7 @@ module Tabnav
   class Tab
 
     def initialize(template, params, html_options = {}) # :nodoc:
+      @partial = html_options.delete(:tab_content_partial)
       @html_options = html_options
       @params = params
       @template = template
@@ -52,23 +53,29 @@ module Tabnav
       end
     end
 
-    # Returns +true+ of this tab is highlighted.
+    # Returns +true+ if this tab is highlighted.
     def active?
       @active
     end
 
     def render # :nodoc:
-      @html_options[:class] = "#{@html_options[:class]} active".strip if self.active?
-      partial = @html_options.delete(:tab_content_partial)
-      @template.content_tag(:li, @html_options) do
-        if partial
-          @template.render :partial => partial, :locals => {:tab => self}
-        elsif has_link?
-          @template.link_to @name, @link_url, @link_options
-        else
-          @template.content_tag :span, @name
-        end
+      options = @html_options.dup
+      options[:class] = "#{options[:class]} active".strip if self.active?
+      @template.content_tag(:li, options) do
+        render_tab
+      end
+    end
+
+    private
+
+    def render_tab
+      if @partial
+        @template.render :partial => @partial, :locals => {:tab => self}
+      elsif has_link?
+        @template.link_to @name, @link_url, @link_options
+      else
+        @template.content_tag :span, @name
       end
     end
   end
-end
+end

data/lib/tabnav/version.rb

@@ -0,0 +1,3 @@
+module Tabnav
+  VERSION = "1.2.0"
+end

data/spec/tabnav/helper_spec.rb

@@ -12,21 +12,21 @@ describe Tabnav::Helper, :type => :helper do
     end
     it "should create a new navbar with the template and params and yield it to the block" do
       controller.params["foo"] = "bar"
-      Tabnav::Navbar.should_receive(:new).with(@template, {"foo" => "bar"}, {}).and_return(@navbar)
+      Tabnav::Navbar.should_receive(:new).with(@template, {"foo" => "bar"}, anything()).and_return(@navbar)
       helper.render_tabnav do |n|
         n.should == @navbar
       end
     end
 
-    it "should create a new navbar with any passed options" do
-      Tabnav::Navbar.should_receive(:new).with(@template, {}, {:class => "my_class", :id => "my_id"}).and_return(@navbar)
+    it "should create a new navbar with any passed options setting it to be the top-level navbar" do
+      Tabnav::Navbar.should_receive(:new).with(@template, {}, {:class => "my_class", :id => "my_id", :top_level => true}).and_return(@navbar)
       helper.render_tabnav :class => "my_class", :id => "my_id" do |n|
         n.should == @navbar
       end
     end
 
     it "should concat the results of calling render on the navbar" do
-      @navbar.should_receive(:render).and_return("Some Navbar Markup")
+      @navbar.should_receive(:render_navbar).and_return("Some Navbar Markup")
       helper.render_tabnav {|n| }
       helper.output_buffer.should == "Some Navbar Markup"
     end

data/spec/tabnav/integration_spec.rb

@@ -176,7 +176,7 @@ describe Tabnav::Helper, :type => :helper do
       helper.should_receive(:render).twice do |args|
         args[:partial].should == '/tab_content'
         args[:locals][:tab].should be_a(Tabnav::Tab)
-        "Custom markup for #{args[:locals][:tab].name}"
+        "Custom markup for #{args[:locals][:tab].name}".html_safe
       end
       helper.render_tabnav do |n|
         n.tab_content_partial = '/tab_content'
@@ -193,5 +193,205 @@ describe Tabnav::Helper, :type => :helper do
           '<ul><li>Custom markup for Home</li>' +
           '<li>Custom markup for Froobles</li></ul>'
     end
+
+    it "should carry custom partials into subnavbars" do
+      helper.should_receive(:render).exactly(3).times do |args|
+        args[:locals][:tab].should be_a(Tabnav::Tab)
+        "#{args[:partial]} markup for #{args[:locals][:tab].name}".html_safe
+      end
+      helper.render_tabnav do |n|
+        n.tab_content_partial = '/tab_content'
+        n.add_tab do |t|
+          t.named "Home"
+          t.links_to "/"
+        end
+        n.add_sub_nav do |sn|
+          sn.named "Froobles"
+          sn.links_to "/froobles"
+
+          sn.add_tab do |t|
+            t.named "New"
+            t.links_to "/froobles/new"
+          end
+        end
+      end
+      helper.output_buffer.should ==
+          '<ul><li>/tab_content markup for Home</li>' +
+          '<li>/tab_content markup for Froobles' +
+          '<ul><li>/tab_content markup for New</li></ul>' +
+          '</li></ul>'
+    end
+
+    it "should allow overriding custom partials in subnavbars" do
+      helper.should_receive(:render).exactly(3).times do |args|
+        args[:locals][:tab].should be_a(Tabnav::Tab)
+        "#{args[:partial]} markup for #{args[:locals][:tab].name}".html_safe
+      end
+      helper.render_tabnav do |n|
+        n.tab_content_partial = '/tab_content'
+        n.add_tab do |t|
+          t.named "Home"
+          t.links_to "/"
+        end
+        n.add_sub_nav do |sn|
+          sn.named "Froobles"
+          sn.links_to "/froobles"
+          sn.tab_content_partial = '/sub_tab_content'
+
+          sn.add_tab do |t|
+            t.named "New"
+            t.links_to "/froobles/new"
+          end
+        end
+      end
+      helper.output_buffer.should ==
+          '<ul><li>/tab_content markup for Home</li>' +
+          '<li>/tab_content markup for Froobles' +
+          '<ul><li>/sub_tab_content markup for New</li></ul>' +
+          '</li></ul>'
+    end
+  end
+
+  describe "nested navbars" do
+    it "should allow a nested navbar" do
+      helper.render_tabnav do |n|
+        n.add_tab do |t|
+          t.named "Home"
+          t.links_to '/'
+          t.highlights_on :controller => :home, :action => :index
+        end
+
+        n.add_sub_nav do |sn|
+          sn.named "Froobles"
+
+          sn.add_tab do |t|
+            t.named "All Froobles"
+            t.links_to '/froobles'
+            t.highlights_on :controller => :froobles, :action => :index
+          end
+
+          sn.add_tab do |t|
+            t.named "New Frooble"
+            t.links_to '/froobles/new'
+            t.highlights_on :controller => :froobles, :action => :new
+            t.highlights_on :controller => :froobles, :action => :create
+          end
+        end
+
+        n.add_tab do |t|
+          t.named "Something Else"
+          t.links_to "/somewhere"
+        end
+      end
+      helper.output_buffer.should == '<ul><li><a href="/">Home</a></li><li><span>Froobles</span>' +
+        '<ul><li><a href="/froobles">All Froobles</a></li><li><a href="/froobles/new">New Frooble</a></li></ul>' +
+        '</li><li><a href="/somewhere">Something Else</a></li></ul>'
+    end
+
+    it "should allow specifying class/id on a nested navbar" do
+      helper.render_tabnav do |n|
+        n.add_tab do |t|
+          t.named "Home"
+          t.links_to '/'
+          t.highlights_on :controller => :home, :action => :index
+        end
+
+        n.add_sub_nav :id => 'froobles' do |sn|
+          sn.named "Froobles"
+
+          sn.add_tab do |t|
+            t.named "All Froobles"
+            t.links_to '/froobles'
+            t.highlights_on :controller => :froobles, :action => :index
+          end
+
+          sn.add_tab do |t|
+            t.named "New Frooble"
+            t.links_to '/froobles/new'
+            t.highlights_on :controller => :froobles, :action => :new
+            t.highlights_on :controller => :froobles, :action => :create
+          end
+        end
+
+        n.add_tab do |t|
+          t.named "Something Else"
+          t.links_to "/somewhere"
+        end
+      end
+      helper.output_buffer.should == '<ul><li><a href="/">Home</a></li><li id="froobles"><span>Froobles</span>' +
+        '<ul><li><a href="/froobles">All Froobles</a></li><li><a href="/froobles/new">New Frooble</a></li></ul>' +
+        '</li><li><a href="/somewhere">Something Else</a></li></ul>'
+    end
+
+    it "highlighting logic should work on a subnavbar" do
+      controller.params['controller'] = 'wibble'
+      helper.render_tabnav do |n|
+        n.add_tab do |t|
+          t.named "Home"
+          t.links_to '/'
+          t.highlights_on :controller => :home, :action => :index
+        end
+
+        n.add_sub_nav do |sn|
+          sn.named "Froobles"
+          sn.highlights_on :controller => :wibble
+
+          sn.add_tab do |t|
+            t.named "All Froobles"
+            t.links_to '/froobles'
+            t.highlights_on :controller => :froobles, :action => :index
+          end
+
+          sn.add_tab do |t|
+            t.named "New Frooble"
+            t.links_to '/froobles/new'
+            t.highlights_on :controller => :froobles, :action => :new
+            t.highlights_on :controller => :froobles, :action => :create
+          end
+        end
+      end
+      helper.output_buffer.should == '<ul><li><a href="/">Home</a></li><li class="active"><span>Froobles</span>' +
+        '<ul><li><a href="/froobles">All Froobles</a></li><li><a href="/froobles/new">New Frooble</a></li></ul>' +
+        '</li></ul>'
+    end
+
+    it "should allow deep nesting of navbars" do
+      helper.render_tabnav do |n|
+        n.add_tab do |t|
+          t.named "Home"
+          t.links_to '/'
+        end
+
+        n.add_sub_nav do |sn|
+          sn.named "Foo"
+
+          sn.add_tab do |t|
+            t.named "All Foos"
+            t.links_to '/foos'
+          end
+
+          sn.add_sub_nav do |ssn|
+            ssn.named "Bars"
+            ssn.links_to '/foos/bars'
+
+            ssn.add_tab do |t|
+              t.named "New Bar"
+              t.links_to '/foos/bars/new'
+            end
+
+            ssn.add_tab do |t|
+              t.named "Wibble"
+              t.highlights_on Proc.new { true }
+            end
+          end
+        end
+      end
+      helper.output_buffer.should == '<ul><li><a href="/">Home</a></li><li><span>Foo</span>' +
+          '<ul><li><a href="/foos">All Foos</a></li><li>' +
+            '<a href="/foos/bars">Bars</a>' + 
+            '<ul><li><a href="/foos/bars/new">New Bar</a></li><li class="active"><span>Wibble</span></li></ul>' + 
+          '</li></ul>' +
+        '</li></ul>'
+    end
   end
 end

data/spec/tabnav/navbar_spec.rb

@@ -9,41 +9,121 @@ describe Tabnav::Navbar do
 
     it "should create a new tab with the passed template and params and yield it to the block" do
       n = Tabnav::Navbar.new(@template, {"foo" => "bar"})
-      t = Tabnav::Tab.new(@template, {})
-      Tabnav::Tab.should_receive(:new).with(@template, {"foo" => "bar"}, {}).and_return(t)
+      tab = Tabnav::Tab.new(@template, {})
+      Tabnav::Tab.should_receive(:new).with(@template, {"foo" => "bar"}, {}).and_return(tab)
       n.add_tab do |t|
-        t.should == t
+        t.should == tab
       end
     end
 
     it "should create the tab with any passed options" do
       n = Tabnav::Navbar.new(@template, {})
-      t = Tabnav::Tab.new(@template, {})
-      Tabnav::Tab.should_receive(:new).with(@template, {}, {:class => "my_class", :id => "my_id"}).and_return(t)
+      tab = Tabnav::Tab.new(@template, {})
+      Tabnav::Tab.should_receive(:new).with(@template, {}, {:class => "my_class", :id => "my_id"}).and_return(tab)
       n.add_tab :class => "my_class", :id => "my_id" do |t|
-        t.should == t
+        t.should == tab
       end
     end
 
     it "should add the custom partial to the options if set" do
       n = Tabnav::Navbar.new(@template, {})
       n.tab_content_partial = 'my_partial'
-      t = Tabnav::Tab.new(@template, {})
-      Tabnav::Tab.should_receive(:new).with(@template, {}, {:id => "my_id", :tab_content_partial => 'my_partial'}).and_return(t)
+      tab = Tabnav::Tab.new(@template, {})
+      Tabnav::Tab.should_receive(:new).with(@template, {}, {:id => "my_id", :tab_content_partial => 'my_partial'}).and_return(tab)
       n.add_tab :id => "my_id" do |t|
-        t.should == t
+        t.should == tab
+      end
+    end
+
+    it "should add the tabnav's partial to the options if one was set" do
+      n = Tabnav::Navbar.new(@template, {}, :tab_content_partial => 'my_partial')
+      tab = Tabnav::Tab.new(@template, {})
+      Tabnav::Tab.should_receive(:new).with(@template, {}, {:id => "my_id", :tab_content_partial => 'my_partial'}).and_return(tab)
+      n.add_tab :id => "my_id" do |t|
+        t.should == tab
+      end
+    end
+
+    it "should use the custom partial in preference to the navbars partial" do
+      n = Tabnav::Navbar.new(@template, {}, :tab_content_partial => 'my_other_partial')
+      n.tab_content_partial = 'my_partial'
+      tab = Tabnav::Tab.new(@template, {})
+      Tabnav::Tab.should_receive(:new).with(@template, {}, {:id => "my_id", :tab_content_partial => 'my_partial'}).and_return(tab)
+      n.add_tab :id => "my_id" do |t|
+        t.should == tab
       end
     end
   end
 
-  describe "render" do
+  describe "add_sub_nav" do
+    before :each do
+      @template = ActionView::Base.new()
+    end
+
+    it "should create a new navbar with the passed template and params and yield it to the block" do
+      n = Tabnav::Navbar.new(@template, {"foo" => "bar"})
+      subnav = Tabnav::Navbar.new(@template, {})
+      Tabnav::Navbar.should_receive(:new).with(@template, {"foo" => "bar"}, {}).and_return(subnav)
+      n.add_sub_nav do |sn|
+        sn.should == subnav
+      end
+    end
+
+    it "should create the tab with any passed options" do
+      n = Tabnav::Navbar.new(@template, {})
+      subnav = Tabnav::Navbar.new(@template, {})
+      Tabnav::Navbar.should_receive(:new).with(@template, {}, {:class => "my_class", :id => "my_id"}).and_return(subnav)
+      n.add_sub_nav :class => "my_class", :id => "my_id" do |sn|
+        sn.should == subnav
+      end
+    end
+
+    it "should add the custom partial to the options if set" do
+      n = Tabnav::Navbar.new(@template, {})
+      n.tab_content_partial = 'my_partial'
+      subnav = Tabnav::Navbar.new(@template, {})
+      Tabnav::Navbar.should_receive(:new).with(@template, {}, {:id => "my_id", :tab_content_partial => 'my_partial'}).and_return(subnav)
+      n.add_sub_nav :id => "my_id" do |sn|
+        sn.should == subnav
+      end
+    end
+
+    it "should add the tabnav's partial to the options if one was set" do
+      n = Tabnav::Navbar.new(@template, {}, :tab_content_partial => 'my_partial')
+      subnav = Tabnav::Navbar.new(@template, {})
+      Tabnav::Navbar.should_receive(:new).with(@template, {}, {:id => "my_id", :tab_content_partial => 'my_partial'}).and_return(subnav)
+      n.add_sub_nav :id => "my_id" do |sn|
+        sn.should == subnav
+      end
+    end
+
+    it "should use the custom partial in preference to the navbars partial" do
+      n = Tabnav::Navbar.new(@template, {}, :tab_content_partial => 'my_other_partial')
+      n.tab_content_partial = 'my_partial'
+      subnav = Tabnav::Navbar.new(@template, {})
+      Tabnav::Navbar.should_receive(:new).with(@template, {}, {:id => "my_id", :tab_content_partial => 'my_partial'}).and_return(subnav)
+      n.add_sub_nav :id => "my_id" do |sn|
+        sn.should == subnav
+      end
+    end
+  end
+
+  describe "Tab behaviour" do
+    it "should be a subclass of Tab" do
+      Tabnav::Navbar.new(nil, nil).should be_a(Tabnav::Tab)
+    end
+  end
+
+  describe "render_navbar" do
     before :each do
       @template = ActionView::Base.new()
     end
 
     it "should output nothing if no tabs have been added" do
       n = Tabnav::Navbar.new(@template, {})
-      n.render.should == ''
+      html = n.render_navbar
+      html.should == ''
+      html.should be_html_safe
     end
 
     it "should output a ul containing the results of rendering each of it's tabs" do
@@ -57,63 +137,42 @@ describe Tabnav::Navbar do
       end
       t1.should_receive(:render).and_return("Tab 1 markup")
       t2.should_receive(:render).and_return("Tab 2 markup")
-      n.render.should == '<ul>Tab 1 markupTab 2 markup</ul>'
+      n.render_navbar.should == '<ul>Tab 1 markupTab 2 markup</ul>'
     end
 
-    it "should pass the options given on creation to the ul" do
-      n = Tabnav::Navbar.new(@template, {}, :id => "my_id", :class => "my_class")
+    it "should pass the options given on creation to the ul when it's the top-level navbar" do
+      n = Tabnav::Navbar.new(@template, {}, :id => "my_id", :class => "my_class", :top_level => true)
       t1 = nil
       n.add_tab do |t|
         t1 = t
       end
       @template.should_receive(:content_tag).with(:ul, {:id => "my_id", :class => "my_class"}).and_return(:some_markup)
-      n.render.should == :some_markup
-    end
-
-#     it "should output a li containing a span with the name if no link given" do
-#       t = Tabnav::Tab.new(@template)
-#       t.named "A Tab"
-#       html = t.render
-#       html.should == "<li><span>A Tab</span></li>"
-#     end
-#
-#     it "should output a li containing a link with the name" do
-#       t = Tabnav::Tab.new(@template)
-#       t.named "A Tab"
-#       t.links_to "/wibble"
-#       html = t.render
-#       html.should == "<li><a href=\"/wibble\">A Tab</a></li>"
-#     end
-#
-#     context "with no name given" do
-#       it "should output a blank tab if no link given" do
-#         t = Tabnav::Tab.new(@template)
-#         html = t.render
-#         html.should == "<li><span></span></li>"
-#       end
-#
-#       it "should output an empty link" do
-#         t = Tabnav::Tab.new(@template)
-#         t.links_to "/wibble"
-#         html = t.render
-#         html.should == "<li><a href=\"/wibble\"></a></li>"
-#       end
-#     end
-#
-#     it "should pass the options given on creation to the li" do
-#       @template.should_receive(:content_tag).with(:li, {:id => "my_id", :class => "my_class"}).and_return(:some_markup)
-#       t = Tabnav::Tab.new(@template, :id => "my_id", :class => "my_class")
-#       t.named "A Tab"
-#       t.render.should == :some_markup
-#     end
-#
-#     it "should pass the options given to the link to link_to" do
-#       @template.should_receive(:link_to).with("A Tab", "/wibble", {:class => "link_class", :target => "_blank"}).and_return("A Link")
-#       t = Tabnav::Tab.new(@template)
-#       t.named "A Tab"
-#       t.links_to "/wibble", :class => "link_class", :target => "_blank"
-#       html = t.render
-#       html.should == "<li>A Link</li>"
-#     end
+      n.render_navbar.should == :some_markup
+    end
+
+    it "should not pass the options to the ul when it's not the top-level navbar" do
+      n = Tabnav::Navbar.new(@template, {}, :id => "my_id", :class => "my_class")
+      t1 = nil
+      n.add_tab do |t|
+        t1 = t
+      end
+      @template.should_receive(:content_tag).with(:ul, nil).and_return(:some_markup)
+      n.render_navbar.should == :some_markup
+    end
+  end
+
+  describe "render" do
+    # This only covers the functionality specific to navbars, the rest is covered in tab_spec
+    before :each do
+      @template = ActionView::Base.new()
+    end
+    it "should insert the navbar inside the end of the li" do
+      n = Tabnav::Navbar.new(@template, {})
+      n.stub!(:render_navbar).and_return("The Navbar")
+      n.named "A Tab"
+      html = n.render
+      html.should == "<li><span>A Tab</span>The Navbar</li>"
+      html.should be_html_safe
+    end
   end
-end
+end

data/spec/tabnav/tab_spec.rb

@@ -43,6 +43,7 @@ describe Tabnav::Tab do
       t.named "A Tab"
       html = t.render
       html.should == "<li><span>A Tab</span></li>"
+      html.should be_html_safe
     end
 
     it "should output a li containing a link with the name" do
@@ -51,6 +52,7 @@ describe Tabnav::Tab do
       t.links_to "/wibble"
       html = t.render
       html.should == "<li><a href=\"/wibble\">A Tab</a></li>"
+      html.should be_html_safe
     end
 
     context "with no name given" do
@@ -58,6 +60,7 @@ describe Tabnav::Tab do
         t = Tabnav::Tab.new(@template, {})
         html = t.render
         html.should == "<li><span></span></li>"
+        html.should be_html_safe
       end
       
       it "should output an empty link" do
@@ -65,6 +68,7 @@ describe Tabnav::Tab do
         t.links_to "/wibble"
         html = t.render
         html.should == "<li><a href=\"/wibble\"></a></li>"
+        html.should be_html_safe
       end
     end
 
@@ -82,6 +86,7 @@ describe Tabnav::Tab do
       t.links_to "/wibble", :class => "link_class", :target => "_blank"
       html = t.render
       html.should == "<li>A Link</li>"
+      html.should be_html_safe
     end
 
     context "with a custom partial" do
@@ -180,6 +185,15 @@ describe Tabnav::Tab do
         t.stub!(:active?).and_return(true)
         t.render.should == '<li class="my_class active"><span>A Tab</span></li>'
       end
+
+      it "should not modify the existing html_options on the tab" do
+        t = Tabnav::Tab.new(@template, {}, {:class => "my_class"})
+        t.named "A Tab"
+        t.stub!(:active?).and_return(true)
+        t.render
+        t.stub!(:active?).and_return(false)
+        t.render.should == '<li class="my_class"><span>A Tab</span></li>'
+      end
     end
   end
 end

data/tabnav.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tabnav/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{tabnav}
+  s.version = Tabnav::VERSION
+
+  s.authors = ["Alex Tomlins", "Unboxed Consulting"]
+  s.email = %q{github@unboxedconsulting.com}
+  s.homepage = %q{http://github.com/unboxed/tabnav}
+  s.summary = %q{Rails helper for generating navbars}
+  s.description = %q{Rails helper for generating navbars in a declarative manner}
+  s.license = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.extra_rdoc_files = %w(LICENSE README.rdoc)
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency(%q<actionpack>, [">= 2.3.8"])
+  s.add_development_dependency(%q<rspec>, ["~> 2.9.0"])
+  s.add_development_dependency(%q<rspec-rails>, ["~> 2.9.0"])
+end

metadata

@@ -1,129 +1,121 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tabnav
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
 platform: ruby
-authors: 
-- Unboxed
+authors:
+- Alex Tomlins
+- Unboxed Consulting
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-15 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: actionpack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 2
-        - 3
-        - 8
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.8
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
+      - !ruby/object:Gem::Version
+        version: 2.9.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec-rails
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 2
-        - 6
-        - 1
-        version: 2.6.1
+      - !ruby/object:Gem::Version
+        version: 2.9.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 description: Rails helper for generating navbars in a declarative manner
 email: github@unboxedconsulting.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
-- .document
+files:
+- .gitignore
 - .rspec
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
+- doc/ideas/basic_flat_navbar.html.erb
+- doc/ideas/custom_tab partial.html.erb
+- doc/ideas/nested_versions.html.erb
 - lib/tabnav.rb
 - lib/tabnav/helper.rb
 - lib/tabnav/navbar.rb
 - lib/tabnav/tab.rb
+- lib/tabnav/version.rb
 - spec/spec_helper.rb
 - spec/tabnav/helper_spec.rb
 - spec/tabnav/integration_spec.rb
 - spec/tabnav/navbar_spec.rb
 - spec/tabnav/tab_spec.rb
-has_rdoc: true
+- tabnav.gemspec
 homepage: http://github.com/unboxed/tabnav
-licenses: []
-
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Rails helper for generating navbars
-test_files: []
-
+test_files:
+- spec/spec_helper.rb
+- spec/tabnav/helper_spec.rb
+- spec/tabnav/integration_spec.rb
+- spec/tabnav/navbar_spec.rb
+- spec/tabnav/tab_spec.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/VERSION

@@ -1 +0,0 @@
-1.1.0