tabs_on_rails 1.2.0 → 1.3.0

data/CHANGELOG.rdoc

@@ -1,6 +1,23 @@
 = Changelog
 
 
+== Release 1.3.0
+
+* ADDED: Ability to customize the behavior and the style of the li tab item
+         passing a hash of options.
+
+           <% tabs_tag do |tab| %>
+             <%= tab.home      'Homepage', root_path, :style => "padding: 10px" %>
+             <%= tab.dashboard 'Dashboard', dashboard_path %>
+           <% end %>
+           
+           <ul>
+             <li style="padding: 10px"><a href="/">Homepage</a></li>
+             <li class="custom"><span>Dashboard</span></li>
+             <li><a href="/account">Account</a></li>
+           </ul>
+
+
 == Release 1.2.0
 
 * ADDED: Rails 3 compatibility.

data/README.rdoc

@@ -72,7 +72,7 @@ The example above produces the following HTML output.
   </ul>
 
 The usage is similar to the Rails route file.
-You create named tabs with the syntax <tt>tab.name_of_tab</tt>. 
+You create named tabs with the syntax <tt>tab.name_of_tab</tt>.
 
 The name you use creating a tab is the same you're going to refer to in your controller
 when you want to mark a tab as the current tab.
@@ -85,7 +85,7 @@ Now, if the action belongs to <tt>DashboardController</tt>, the template will au
 
   <ul>
     <li><a href="/">Homepage</a></li>
-    <li><span>Dashboard</span></li>
+    <li class="custom"><span>Dashboard</span></li>
     <li><a href="/account">Account</a></li>
   </ul>
 
@@ -98,7 +98,28 @@ Use the <tt>current_tab</tt> helper method if you need to access the value of cu
   # In your view
   <p>The name of current tab is <%= current_tab %>.</p>
 
-The open_tag can be customized with the <tt>:open_tabs</tt> option.
+=== Customizing a Tab
+
+You can pass a hash of options to customize the style and the behavior of the tab item.
+Behind the scenes, each time you create a tab, the <tt>#tab_for</tt> 
+method is invoked.
+
+  <% tabs_tag do |tab| %>
+    <%= tab.home      'Homepage', root_path, :style => "padding: 10px" %>
+    <%= tab.dashboard 'Dashboard', dashboard_path %>
+  <% end %>
+
+  <ul>
+    <li style="padding: 10px"><a href="/">Homepage</a></li>
+    <li class="custom"><span>Dashboard</span></li>
+    <li><a href="/account">Account</a></li>
+  </ul>
+
+See <tt>TabsOnRails::Tabs::TabsBuilder#tab_for</tt> for more details.
+
+=== Customizing open_tabs and close_tabs
+
+The open_tabs and the close_tabs methods can be customized with the <tt>:open_tabs</tt> and <tt>:close_tabs</tt> option.
 
   <% tabs_tag :open_tabs => { :id => "tabs", :class => "cool" } do |tab| %>
     <%= tab.home      'Homepage', root_path %>
@@ -112,6 +133,7 @@ The open_tag can be customized with the <tt>:open_tabs</tt> option.
     <li><a href="/account">Account</a></li>
   </ul>
 
+
 Further customizations require a custom <tt>Builder</tt> (see below).
 
 

data/lib/tabs_on_rails/controller_mixin.rb

@@ -144,7 +144,7 @@ module TabsOnRails
       # 
       #   <ul>
       #     <li><a href="/">Homepage</a></li>
-      #     <li><span>Dashboard</span></li>
+      #     <li class="custom"><span>Dashboard</span></li>
       #     <li><a href="/account">Account</a></li>
       #   </ul>
       #
@@ -158,7 +158,34 @@ module TabsOnRails
       #   # In your view
       #   <p>The name of current tab is <%= current_tab %>.</p>
       #
-      # The open_tag can be customized with the <tt>:open_tabs</tt> option.
+      # === Customizing a Tab
+      #
+      # You can pass a hash of options to customize the style and the behavior of the tab item.
+      # Behind the scenes, each time you create a tab, the <tt>#tab_for</tt> 
+      # method is invoked.
+      #
+      #   <% tabs_tag do |tab| %>
+      #     <%= tab.home      'Homepage', root_path, :style => "padding: 10px" %>
+      #     <%= tab.dashboard 'Dashboard', dashboard_path %>
+      #   <% end %>
+      #
+      #   <ul>
+      #     <li style="padding: 10px"><a href="/">Homepage</a></li>
+      #     <li class="custom"><span>Dashboard</span></li>
+      #     <li><a href="/account">Account</a></li>
+      #   </ul>
+      #
+      # You can pass any option supported by the <li>content_tag</li> Rails helper.
+      # Additionally, the following options have a special meaning:
+      #
+      # * <tt>link_current</tt>: forces the current tab to be a link, instead of a span tag
+      #
+      # See <tt>TabsOnRails::Tabs::TabsBuilder#tab_for</tt> for more details.
+      #
+      # === Customizing open_tabs and close_tabs
+      #
+      # The open_tabs and the close_tabs methods can be customized 
+      # with the <tt>:open_tabs</tt> and <tt>:close_tabs</tt> option.
       #
       #   <% tabs_tag :open_tabs => { :id => "tabs", :class => "cool" } do |tab| %>
       #     <%= tab.home      'Homepage', root_path %>

data/lib/tabs_on_rails/tabs/tabs_builder.rb

@@ -30,19 +30,27 @@ module TabsOnRails
       #   current_tab? :foo   # => true
       # 
       #   tab_for :foo, 'Foo', foo_path
-      #   # => <li><span>Foo</span></li>
+      #   # => "<li class="current"><span>Foo</span></li>"
       # 
       #   tab_for :bar, 'Bar', bar_path
-      #   # => <li><a href="/link/to/bar">Bar</a></li>
+      #   # => "<li><a href="/link/to/bar">Bar</a></li>"
       # 
+      # You can pass a hash of <tt>item_options</tt>
+      # to customize the behavior and the style of the li element.
+      #
+      #   # Pass a custom class to the element
+      #   tab_for :bar, 'Bar', bar_path, :class => "custom"
+      #   # => "<li class="custom"><a href="/link/to/bar">Bar</a></li>"
+      #
       # Implements Builder#tab_for.
       #
-      def tab_for(tab, name, options)
+      def tab_for(tab, name, options, item_options = {})
+        item_options[:class] = item_options[:class].to_s.split(" ").push("current").join(" ") if current_tab?(tab)
         content = @context.link_to_unless(current_tab?(tab), name, options) do
           @context.content_tag(:span, name)
         end
-        @context.content_tag(:li, content)
-      end
+        @context.content_tag(:li, content, item_options)
+     end
 
       # Returns an unordered list open tag.
       #

data/lib/tabs_on_rails/version.rb

@@ -18,7 +18,7 @@ module TabsOnRails
 
   module Version
     MAJOR = 1
-    MINOR = 2
+    MINOR = 3
     PATCH = 0
     BUILD = nil
 

data/tabs_on_rails.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tabs_on_rails}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Simone Carletti"]
-  s.date = %q{2010-08-09}
+  s.date = %q{2010-08-10}
   s.description = %q{    TabsOnRails is a simple Ruby on Rails plugin for creating and managing Tabs.     It provides helpers for creating tabs with a flexible interface.
 }
   s.email = %q{weppos@weppos.net}
   s.extra_rdoc_files = ["CHANGELOG.rdoc", "LICENSE.rdoc", "README.rdoc"]
-  s.files = ["Rakefile", "init.rb", "CHANGELOG.rdoc", "LICENSE.rdoc", "README.rdoc", "tabs_on_rails.gemspec", "test/controller_mixin_test.rb", "test/fixtures/mixin/default.html.erb", "test/fixtures/mixin/with_open_close_tabs.html.erb", "test/tabs/builder_test.rb", "test/tabs/tabs_builder_test.rb", "test/tabs_test.rb", "test/test_helper.rb", "lib/tabs_on_rails/controller_mixin.rb", "lib/tabs_on_rails/tabs/builder.rb", "lib/tabs_on_rails/tabs/tabs_builder.rb", "lib/tabs_on_rails/tabs.rb", "lib/tabs_on_rails/version.rb", "lib/tabs_on_rails.rb", "rails/init.rb"]
+  s.files = ["Rakefile", "init.rb", "CHANGELOG.rdoc", "LICENSE.rdoc", "README.rdoc", "tabs_on_rails.gemspec", "test/controller_mixin_test.rb", "test/fixtures/mixin/default.html.erb", "test/fixtures/mixin/with_open_close_tabs.html.erb", "test/tabs/builder_test.rb", "test/tabs/tabs_builder_test.rb", "test/tabs_test.rb", "test/test_helper.rb", "lib/tabs_on_rails/controller_mixin.rb", "lib/tabs_on_rails/railtie.rb", "lib/tabs_on_rails/tabs/builder.rb", "lib/tabs_on_rails/tabs/tabs_builder.rb", "lib/tabs_on_rails/tabs.rb", "lib/tabs_on_rails/version.rb", "lib/tabs_on_rails.rb", "rails/init.rb"]
   s.homepage = %q{http://www.simonecarletti.com/code/tabs_on_rails}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/test/controller_mixin_test.rb

@@ -151,7 +151,7 @@ class ControllerMixinHelpersTest < ActionView::TestCase
       concat t.single('Single', '#')
     end
 
-    assert_dom_equal('<span>Single</span>', content)
+    assert_dom_equal '<span>Single</span>', content
   end
 
   def test_tabs_tag_should_not_concat_open_tabs_when_nil
@@ -159,7 +159,7 @@ class ControllerMixinHelpersTest < ActionView::TestCase
       concat t.single('Single', '#')
     end
 
-    assert_dom_equal('<span>Single</span><br />', content)
+    assert_dom_equal '<span>Single</span><br />', content
   end
 
   def test_tabs_tag_should_not_concat_close_tabs_when_nil
@@ -167,7 +167,7 @@ class ControllerMixinHelpersTest < ActionView::TestCase
       concat t.single('Single', '#')
     end
 
-    assert_dom_equal('<br /><span>Single</span>', content)
+    assert_dom_equal '<br /><span>Single</span>', content
   end
 
 end
@@ -208,27 +208,35 @@ class ControllerMixinWithControllerTest < ActionController::TestCase
 
   def test_render_default
     get :action_dashboard
-    assert_equal(%Q{<ul>
-  <li><span>Dashboard</span></li>
+    assert_dom_equal(%Q{<ul>
+  <li class="current"><span>Dashboard</span></li>
   <li><a href="/w">Welcome</a></li>
 </ul>}, @response.body)
   end
 
   def test_render_with_open_close_tabs
     get :action_dashboard, :template => "with_open_close_tabs"
-    assert_equal(%Q{<ul id="tabs">
-  <li><span>Dashboard</span></li>
+    assert_dom_equal(%Q{<ul id="tabs">
+  <li class="current"><span>Dashboard</span></li>
   <li><a href="/w">Welcome</a></li>
 </ul>}, @response.body)
   end
 
+  def test_render_with_item_options
+    get :action_dashboard, :template => "with_item_options"
+    assert_dom_equal(%Q{<ul id="tabs">
+  <li class="custom current"><span>Dashboard</span></li>
+  <li class="custom"><a href="/w">Welcome</a></li>
+</ul>}, @response.body)
+  end
+
 
   def test_set_tab
     get :action_dashboard
     assert_equal(:dashboard, controller.current_tab)
     assert_equal(:dashboard, controller.current_tab(:default))
-    assert_equal(%Q{<ul>
-  <li><span>Dashboard</span></li>
+    assert_dom_equal(%Q{<ul>
+  <li class="current"><span>Dashboard</span></li>
   <li><a href="/w">Welcome</a></li>
 </ul>}, @response.body)
   end
@@ -237,9 +245,9 @@ class ControllerMixinWithControllerTest < ActionController::TestCase
     get :action_welcome
     assert_equal(:welcome, controller.current_tab)
     assert_equal(:welcome, controller.current_tab(:default))
-    assert_equal(%Q{<ul>
+    assert_dom_equal(%Q{<ul>
   <li><a href="/d">Dashboard</a></li>
-  <li><span>Welcome</span></li>
+  <li class="current"><span>Welcome</span></li>
 </ul>}, @response.body)
   end
 
@@ -248,8 +256,8 @@ class ControllerMixinWithControllerTest < ActionController::TestCase
     assert_equal(:dashboard, controller.current_tab)
     assert_equal(:dashboard, controller.current_tab(:default))
     assert_equal(:homepage, controller.current_tab(:namespace))
-    assert_equal(%Q{<ul>
-  <li><span>Dashboard</span></li>
+    assert_dom_equal(%Q{<ul>
+  <li class="current"><span>Dashboard</span></li>
   <li><a href="/w">Welcome</a></li>
 </ul>}, @response.body)
   end

data/test/fixtures/mixin/with_item_options.html.erb

@@ -0,0 +1,4 @@
+<% tabs_tag(:open_tabs => { :id => "tabs" }, :close_tabs => { :class => "ignored" }) do |tabs| %>
+  <%= tabs.dashboard 'Dashboard', '/d', :class => "custom" %>
+  <%= tabs.welcome 'Welcome', '/w', :class => "custom" %>
+<% end -%>

data/test/tabs/tabs_builder_test.rb

@@ -49,15 +49,33 @@ class TabsBuilderTest < ActionView::TestCase
   def test_tab_for_should_return_link_to_unless_current_tab
     assert_dom_equal %Q{<li><a href="#">Welcome</a></li>},
                      @builder.tab_for(:welcome, 'Welcome', '#')
-    assert_dom_equal %Q{<li><a href="http://foobar.com/">Foo Bar</a></li>},
-                     @builder.tab_for(:welcome, 'Foo Bar', 'http://foobar.com/')
+    assert_dom_equal %Q{<li><a href="#">Foo Welcome</a></li>},
+                     @builder.tab_for(:welcome, 'Foo Welcome', '#')
   end
 
   def test_tab_for_should_return_span_if_current_tab
-    assert_dom_equal %Q{<li><span>Dashboard</span></li>},
+    assert_dom_equal %Q{<li class="current"><span>Dashboard</span></li>},
                      @builder.tab_for(:dashboard, 'Dashboard', '#')
-    assert_dom_equal %Q{<li><span>Foo Bar</span></li>},
-                     @builder.tab_for(:dashboard, 'Foo Bar', '#')
+    assert_dom_equal %Q{<li class="current"><span>Foo Dashboard</span></li>},
+                     @builder.tab_for(:dashboard, 'Foo Dashboard', '#')
+  end
+
+  def test_tab_for_with_options_as_uri
+    assert_dom_equal %Q{<li><a href="http://welcome.com/">Foo Bar</a></li>},
+                     @builder.tab_for(:welcome, 'Foo Bar', 'http://welcome.com/')
+    assert_dom_equal %Q{<li class="current"><span>Foo Bar</span></li>},
+                     @builder.tab_for(:dashboard, 'Foo Bar', 'http://dashboard.com/')
+  end
+
+  def test_tab_for_with_item_options
+    assert_dom_equal %Q{<li class="custom current"><span>Dashboard</span></li>},
+                     @builder.tab_for(:dashboard, "Dashboard", "#", :class => "custom")
+    assert_dom_equal %Q{<li class="custom"><a href="#">Welcome</a></li>},
+                     @builder.tab_for(:welcome, "Welcome", "#", :class => "custom")
+    assert_dom_equal %Q{<li style="padding: 10px" class="current"><span>Dashboard</span></li>},
+                     @builder.tab_for(:dashboard, "Dashboard", "#", :style => "padding: 10px")
+    assert_dom_equal %Q{<li style="padding: 10px"><a href="#">Welcome</a></li>},
+                     @builder.tab_for(:welcome, "Welcome", "#", :style => "padding: 10px")
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tabs_on_rails
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: false
   segments: 
   - 1
-  - 2
+  - 3
   - 0
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Simone Carletti
@@ -38,6 +38,7 @@ files:
 - tabs_on_rails.gemspec
 - test/controller_mixin_test.rb
 - test/fixtures/mixin/default.html.erb
+- test/fixtures/mixin/with_item_options.html.erb
 - test/fixtures/mixin/with_open_close_tabs.html.erb
 - test/tabs/builder_test.rb
 - test/tabs/tabs_builder_test.rb