tabnav 1.0.0

data/.document

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

data/LICENSE

@@ -0,0 +1,24 @@
+LICENSE
+
+The MIT License
+
+Copyright (c) 2010 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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,136 @@
+= Tabnav
+
+Tabnav is a helper for generating navigation bars. It allows you to simply specify highlighting rules for each tab.
+
+* Homepage: http://github.com/unboxed/tabnav
+* Issues: http://github.com/unboxed/tabnav/issues
+
+== Some Examples
+
+=== Simple Example
+
+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_tab do |t|
+        t.named "Froobles"
+        t.links_to froobles_path
+        t.highlights_on :controller => :froobles
+      end
+    end
+  %>
+
+On home/index will output:
+
+  <ul>
+    <li class="active"><a href="/">Home</a></li>
+    <li><a href="/froobles">Froobles</a></li>
+  </ul>
+
+On any action in FrooblesController will output:
+
+  <ul>
+    <li><a href="/">Home</a></li>
+    <li class="active"><a href="/froobles">Froobles</a></li>
+  </ul>
+
+See the highlights_on method of Tabnav::Tab for full details of the highlighting logic.
+
+=== Options for controlling markup
+
+View:
+
+  <%
+    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 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>
+  </ul>
+
+=== Custom tab partial
+
+It is also possible to specify a partial to be used to generate the tab contents.  e.g.:
+
+View:
+
+  <%
+    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 the partial, +tab+ will be the Tab instance to be rendered.
+
+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 the output will be:
+
+  <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>
+
+-----
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile, gemspec, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Unboxed. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+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.2"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rspec-rails", ">= 1.2.9"
+    gem.files.exclude "*.gemspec", '.gitignore', 'doc/*'
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tabnav #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/tabnav/helper.rb

@@ -0,0 +1,17 @@
+module Tabnav
+  module Helper
+
+    # This is the main method to be used in your views.
+    # It creates and yields a new instance of Navbar.
+    #
+    # +options+ is an optional hash of options that are passed to the navbar, and 
+    # and used to create the +ul+.
+    #
+    # Finally, this renders the navbar, and concats the result into the view.
+    def render_tabnav(options = {})
+      n = Navbar.new(self, params, options)
+      yield(n)
+      concat( n.render )
+    end
+  end
+end

data/lib/tabnav/navbar.rb

@@ -0,0 +1,36 @@
+module Tabnav
+  class Navbar
+    def initialize(template, params, options = {}) # :nodoc:
+      @template = template
+      @params = params
+      @html_options = options
+      @tabs = []
+    end
+
+    # Optionally specifies a partial to be used to render the tab content.
+    attr_writer :tab_content_partial
+
+    # Creates a Tab and adds it to the navbar.
+    #
+    # +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
+    end
+
+    def render # :nodoc:
+      return '' if @tabs.empty?
+      @template.content_tag :ul, @html_options do
+        contents = ''
+        @tabs.each do |tab|
+          contents += tab.render
+        end
+        contents
+      end
+    end
+  end
+end

data/lib/tabnav/tab.rb

@@ -0,0 +1,69 @@
+module Tabnav
+  class Tab
+
+    def initialize(template, params, html_options = {}) # :nodoc:
+      @html_options = html_options
+      @params = params
+      @template = template
+      @name = ''
+      @active = false
+    end
+
+    # The name of this tab
+    attr_accessor :name
+
+    # The link destination
+    attr_accessor :link_url
+
+    # The link options (if any)
+    attr_accessor :link_options
+
+    # Sets the name of this tab.  This will be used as the contents of the link or span
+    def named(text)
+      @name = text
+    end
+
+    # Sets the link destination.
+    #
+    # +link_options+ is an option hash of options that will be
+    # passed through to the link_to call.
+    def links_to(url, link_options = {})
+      @link_url = url
+      @link_options = link_options
+    end
+
+    # Adds a highlight condition to this tab.  +rule+ can be one of the following:
+    #
+    # * A Hash: The tab will be highlighted if all the values in the given hash match the
+    #   params hash (strings and symbols are treated as equivelent).
+    # * A Proc: The proc will be called, and the tab will be highlighted if it returns true.
+    #
+    # If multiple highlight conditions are given, the tab will be highlighted if any of them match.
+    def highlights_on(rule)
+      if rule.is_a?(Hash)
+        @active |= rule.with_indifferent_access.all? {|k, v| @params[k] == v.to_s}
+      elsif rule.is_a?(Proc)
+        @active |= rule.call
+      end
+    end
+
+    # Returns +true+ of 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 @link_url
+          @template.link_to @name, @link_url, @link_options
+        else
+          @template.content_tag :span, @name
+        end
+      end
+    end
+  end
+end

data/lib/tabnav.rb

@@ -0,0 +1,8 @@
+
+module Tabnav
+end
+
+require 'tabnav/tab'
+require 'tabnav/navbar'
+require 'tabnav/helper'
+ActionController::Base.helper Tabnav::Helper

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'action_controller'
+require 'tabnav'
+
+require 'spec'
+require 'spec/autorun'
+
+# The parts of rspec-rails necessary to use helper example groups
+class ApplicationController < ActionController::Base
+end
+require 'active_support/test_case'
+require 'spec/test/unit'
+require 'spec/rails/example'
+require 'spec/rails/interop/testcase'
+
+Spec::Runner.configure do |config|
+
+end

data/spec/tabnav/helper_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Tabnav::Helper, :type => :helper do
+
+  describe "render_tabnav" do
+    before :each do
+      # helper is an instance of a subclass of ActionView::Base
+      @template = helper
+      @navbar = Tabnav::Navbar.new(@template, {})
+      Tabnav::Navbar.stub!(:new).and_return(@navbar)
+      helper.output_buffer = ''
+    end
+    it "should create a new navbar with the template and params and yield it to the block" do
+      params[:foo] = "bar"
+      Tabnav::Navbar.should_receive(:new).with(@template, {"foo" => "bar"}, {}).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)
+      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")
+      helper.render_tabnav {|n| }
+      helper.output_buffer.should == "Some Navbar Markup"
+    end
+  end
+
+  it "should be included in ActionController::Base's helpers" do
+    ActionController::Base.helpers.should be_a(Tabnav::Helper)
+  end
+end

data/spec/tabnav/integration_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe Tabnav::Helper, :type => :helper do
+  before :each do
+    helper.output_buffer = ''
+  end
+
+  describe "basic flat navbar" do
+    it "should output a basic 2 tab navbar" do
+      helper.render_tabnav do |n|
+        n.add_tab do |t|
+          t.named "Home"
+          t.links_to "/"
+        end
+        n.add_tab do |t|
+          t.named "Froobles"
+          t.links_to "/froobles"
+        end
+      end
+      helper.output_buffer.should == '<ul><li><a href="/">Home</a></li><li><a href="/froobles">Froobles</a></li></ul>'
+    end
+
+    it "should output a basic 2 tab navbar with extra markup options" do
+      helper.render_tabnav :id => "main_navigation", :class => "clearfix" do |n|
+        n.add_tab :class => "home_tab" do |t|
+          t.named "Home"
+          t.links_to "/"
+        end
+        n.add_tab :class => "heading" do |t|
+          t.named "Froobles Heading"
+        end
+        n.add_tab do |t|
+          t.named "Froobles"
+          t.links_to "/froobles", :target => "_blank", :rel => "http://foo.bar/"
+        end
+      end
+      helper.output_buffer.should == '<ul class="clearfix" id="main_navigation"><li class="home_tab"><a href="/">Home</a></li>' +
+          '<li class="heading"><span>Froobles Heading</span></li>' +
+          '<li><a href="/froobles" rel="http://foo.bar/" target="_blank">Froobles</a></li></ul>'
+    end
+  end
+
+  describe "highlighting logic" do
+    context "params based rules" do
+      it "should highlight the tab if the rules match the params hash" do
+        params[:controller] = 'home'
+        params[:action] = 'index'
+        params[:foo] = 'bar'
+        helper.render_tabnav :id => "main_navigation", :class => "clearfix" do |n|
+          n.add_tab :class => "home_tab" do |t|
+            t.named "Home"
+            t.links_to '/'
+            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', :target => "_blank", :rel => "http://foo.bar/"
+            t.highlights_on :controller => :froobles, :action => :index
+          end
+        end
+        helper.output_buffer.should == '<ul class="clearfix" id="main_navigation"><li class="home_tab active"><a href="/">Home</a></li>' +
+            '<li class="heading"><span>Froobles Heading</span></li>' +
+            '<li><a href="/froobles" rel="http://foo.bar/" target="_blank">Froobles</a></li></ul>'
+      end
+
+      it "should allow multiple tabs to be active at once" do
+        params[:controller] = 'froobles'
+        params[:action] = 'index'
+        params[:foo] = 'bar'
+        helper.render_tabnav do |n|
+          n.add_tab :class => "home_tab" do |t|
+            t.named "Home"
+            t.links_to '/'
+            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', :target => "_blank", :rel => "http://foo.bar/"
+            t.highlights_on :controller => :froobles, :action => :index
+          end
+        end
+        helper.output_buffer.should == '<ul><li class="home_tab"><a href="/">Home</a></li>' +
+            '<li class="heading active"><span>Froobles Heading</span></li>' +
+            '<li class="active"><a href="/froobles" rel="http://foo.bar/" target="_blank">Froobles</a></li></ul>'
+      end
+
+      it "should highlight tabs where any of the highlighting rules match" do
+        params[:controller] = 'home'
+        params[:action] = 'froobles'
+        params[:foo] = 'bar'
+        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_tab do |t|
+            t.named "Froobles"
+            t.links_to "/froobles"
+            t.highlights_on :controller => :home, :action => :froobles
+            t.highlights_on :controller => :froobles
+          end
+        end
+        helper.output_buffer.should == '<ul><li><a href="/">Home</a></li><li class="active"><a href="/froobles">Froobles</a></li></ul>'
+      end
+    end
+
+    context "proc based rules" do
+      it "should highlight the tab if the give proc evaluates to true" do
+        helper.render_tabnav do |n|
+          n.add_tab do |t|
+            t.named "Home"
+            t.links_to "/"
+            t.highlights_on Proc.new { true }
+          end
+          n.add_tab do |t|
+            t.named "Froobles"
+            t.links_to "/froobles"
+            t.highlights_on Proc.new { false }
+          end
+        end
+        helper.output_buffer.should == '<ul><li class="active"><a href="/">Home</a></li><li><a href="/froobles">Froobles</a></li></ul>'
+      end
+    end
+
+    it "should allow a mixture of rule types" do
+      params[:controller] = 'home'
+      params[:action] = 'index'
+      params[:foo] = 'bar'
+      helper.render_tabnav do |n|
+        n.add_tab :class => "home_tab" do |t|
+          t.named "Home"
+          t.links_to '/'
+          t.highlights_on :controller => :home, :action => :index
+        end
+        n.add_tab :class => "heading" do |t|
+          t.named "Froobles Heading"
+          t.highlights_on :controller => :froobles
+          t.highlights_on Proc.new { true }
+        end
+        n.add_tab do |t|
+          t.named "Froobles"
+          t.links_to '/froobles', :target => "_blank", :rel => "http://foo.bar/"
+          t.highlights_on :controller => :froobles, :action => :index
+        end
+      end
+      helper.output_buffer.should == '<ul><li class="home_tab active"><a href="/">Home</a></li>' +
+          '<li class="heading active"><span>Froobles Heading</span></li>' +
+          '<li><a href="/froobles" rel="http://foo.bar/" target="_blank">Froobles</a></li></ul>'
+    end
+  end
+
+  describe "custom tab partials" do
+    it "should allow sppecifying a custom partial for rendering the tabs" 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}"
+      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_tab do |t|
+          t.named "Froobles"
+          t.links_to "/froobles"
+        end
+      end
+      helper.output_buffer.should ==
+          '<ul><li>Custom markup for Home</li>' +
+          '<li>Custom markup for Froobles</li></ul>'
+    end
+  end
+end

data/spec/tabnav/navbar_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe Tabnav::Navbar do
+
+  describe "add_tab" do
+    before :each do
+      @template = ActionView::Base.new()
+    end
+
+    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)
+      n.add_tab do |t|
+        t.should == t
+      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)
+      n.add_tab :class => "my_class", :id => "my_id" do |t|
+        t.should == t
+      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)
+      n.add_tab :id => "my_id" do |t|
+        t.should == t
+      end
+    end
+  end
+
+  describe "render" 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 == ''
+    end
+
+    it "should output a ul containing the results of rendering each of it's tabs" do
+      n = Tabnav::Navbar.new(@template, {})
+      t1 = t2 = nil
+      n.add_tab do |t|
+        t1 = t
+      end
+      n.add_tab do |t|
+        t2 = t
+      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>'
+    end
+
+    it "should pass the options given on creation to the ul" 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, {: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
+  end
+end

data/spec/tabnav/tab_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe Tabnav::Tab do
+
+  describe "accessors" do
+    before :each do
+      @tab = Tabnav::Tab.new(nil, {})
+      @tab.named "A Tab"
+      @tab.links_to "/somewhere", :target => "_blank"
+    end
+
+    it "should have a name accessor" do
+      @tab.name.should == "A Tab"
+    end
+
+    it "should have a link_url accessor" do
+      @tab.link_url.should == "/somewhere"
+    end
+
+    it "should have a link_options accessor" do
+      @tab.link_options.should == {:target => "_blank"}
+    end
+  end
+
+  describe "render" do
+    before :each do
+      @template = ActionView::Base.new()
+    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
+
+    context "with a custom partial" do
+      it "should render the partial, assigning the tab" do
+        t = Tabnav::Tab.new(@template, {}, :tab_content_partial => 'my_partial')
+        t.named "A Tab"
+        @template.should_receive(:render).with(:partial => 'my_partial', :locals => {:tab => t}).and_return("Custom tab markup")
+        t.render.should == "<li>Custom tab markup</li>"
+      end
+    end
+  end
+
+  describe "highlighting rules" do
+    describe "active logic" do
+      describe "params based rules" do
+        it "should be active if all the optons in the rule match the params" do
+          params = {"key1" => "a_value", "key2" => "another_value", "key3" => "something else"}
+          t = Tabnav::Tab.new(@template, params)
+          t.highlights_on "key1" => "a_value", "key2" => "another_value"
+          t.should be_active
+        end
+
+        it "should not be active if only some of the values match" do
+          params = {"key1" => "a_value", "key2" => "another_value", "key3" => "something else"}
+          t = Tabnav::Tab.new(@template, params)
+          t.highlights_on "key1" => "a_value", "key2" => "a different value"
+          t.should_not be_active
+        end
+
+        it "should not be active if some of the values are missing" do
+          params = {"key1" => "a_value", "key3" => "something else"}
+          t = Tabnav::Tab.new(@template, params)
+          t.highlights_on "key1" => "a_value", "key2" => "another_value"
+          t.should_not be_active
+        end
+
+        it "should be active if any of the rules match" do
+          params = {"key1" => "a_value", "key2" => "another_value", "key3" => "something else"}
+          t = Tabnav::Tab.new(@template, params)
+          t.highlights_on "key1" => "a_value", "key2" => "a different value"
+          t.highlights_on "key1" => "a_value"
+          t.highlights_on "key2" => "wibble"
+          t.should be_active
+        end
+
+        it "should treat strings ans symobls at matching" do
+          params = {"key1" => "a_value", "key2" => "another_value", "key3" => "something else"}
+          t = Tabnav::Tab.new(@template, params)
+          t.highlights_on :key1 => "a_value", :key2 => :another_value
+          t.should be_active
+        end
+      end
+
+      describe "proc based rules" do
+        it "should be active if the proc returns true" do
+          t = Tabnav::Tab.new(@template, {})
+          t.highlights_on Proc.new { true }
+          t.should be_active
+        end
+
+        it "should not be active if the proc returns false" do
+          t = Tabnav::Tab.new(@template, {})
+          t.highlights_on Proc.new { false }
+          t.should_not be_active
+        end
+
+        it "should co-erce the result of the proc to a boolean" do
+          t = Tabnav::Tab.new(@template, {})
+          t.highlights_on Proc.new { "wibble" }
+          t.active?.should == true
+        end
+      end
+    end
+
+    describe "output" do
+      before :each do
+        @template = ActionView::Base.new()
+      end
+      it "should set the class of the li to active if the tab is highlighted" do
+        t = Tabnav::Tab.new(@template, {})
+        t.named "A Tab"
+        t.stub!(:active?).and_return(true)
+        t.render.should == '<li class="active"><span>A Tab</span></li>'
+      end
+
+      it "should merge active with the other classes if highlighted" do
+        t = Tabnav::Tab.new(@template, {}, {:class => "my_class"})
+        t.named "A Tab"
+        t.stub!(:active?).and_return(true)
+        t.render.should == '<li class="my_class active"><span>A Tab</span></li>'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: tabnav
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Unboxed
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+description: Rails helper for generating navbars in a declarative manner
+email: github@unboxedconsulting.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tabnav.rb
+- lib/tabnav/helper.rb
+- lib/tabnav/navbar.rb
+- lib/tabnav/tab.rb
+- spec/spec.opts
+- 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
+homepage: http://github.com/unboxed/tabnav
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails helper for generating navbars
+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