tabs_on_rails 2.0.1 → 2.0.2

data/CHANGELOG.rdoc

@@ -1,6 +1,17 @@
 = Changelog
 
 
+== Release 2.0.2
+
+* NEW: Added support for nested tabs and ability
+  to pass a block to the #tab_for method (#12, #9, #11).
+
+  However, the default TabsBuilder builder does not implement it.
+  Create a custom builder and specify how the block should be rendered.
+
+* CHANGED: Removed deprecated #has_rdoc= RubyGems attribute.
+
+
 == Release 2.0.1
 
 * NEW: Added support for rubygems-test.

data/README.rdoc

@@ -296,5 +296,5 @@ This is the final result.
 
 == License
 
-*TabsOnRails* is Copyright (c) 2009-2011 Simone Carletti.
+TabsOnRails is Copyright (c) 2009-2011 Simone Carletti.
 This is Free Software distributed under the MIT license.

data/Rakefile

@@ -1,11 +1,8 @@
 require 'rubygems'
+require 'rubygems/package_task'
+require 'bundler'
 require 'rake/testtask'
-require 'rake/gempackagetask'
-begin
-  require 'hanna/rdoctask'
-rescue LoadError
-  require 'rake/rdoctask'
-end
+require 'rdoc/task'
 
 $:.unshift(File.dirname(__FILE__) + '/lib')
 require 'tabs_on_rails/version'
@@ -30,16 +27,13 @@ task :default => :test
 spec = Gem::Specification.new do |s|
   s.name              = PKG_NAME
   s.version           = PKG_VERSION
-  s.summary           = "A simple Ruby on Rails plugin for creating and managing Tabs."
+  s.summary           = "A simple Ruby on Rails plugin for creating tabs and navigation menus."
+  s.description       = "TabsOnRails is a simple Rails plugin for creating tabs and navigation menus."
+
   s.author            = "Simone Carletti"
   s.email             = "weppos@weppos.net"
   s.homepage          = "http://www.simonecarletti.com/code/tabs_on_rails"
-  s.description       = <<-EOD
-    TabsOnRails is a simple Ruby on Rails plugin for creating and managing Tabs. \
-    It provides helpers for creating tabs with a flexible interface.
-  EOD
 
-  s.has_rdoc          = true
   # You should probably have a README of some kind. Change the filename
   # as appropriate
   s.extra_rdoc_files  = Dir.glob("*.rdoc")
@@ -47,15 +41,11 @@ spec = Gem::Specification.new do |s|
 
   # Add any extra files to include in the gem (like your README)
   s.files             = %w( Rakefile LICENSE init.rb .gemtest ) + Dir.glob("*.{rdoc,gemspec}") + Dir.glob("{lib,test,rails}/**/*")
-  s.require_paths     = ["lib"]
+  s.require_paths     = %w( lib )
 
-  # If you want to depend on other gems, add them here, along with any
-  # relevant versions
-  # s.add_dependency("some_other_gem", "~> 0.1.0")
-
-  # If your tests use any gems, include them here
   s.add_development_dependency("bundler")
-  s.add_development_dependency("rails", "3.0.3")
+  s.add_development_dependency("hanna-nouveau")
+  s.add_development_dependency("rails", "~> 3.0.6")
   s.add_development_dependency("mocha", "~> 0.9.10")
 end
 
@@ -63,7 +53,7 @@ end
 # .gemspec file, which is useful if something (i.e. GitHub) will
 # be automatically building a gem for this project. If you're not
 # using GitHub, edit as appropriate.
-Rake::GemPackageTask.new(spec) do |pkg|
+Gem::PackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
@@ -93,24 +83,11 @@ Rake::TestTask.new do |t|
 end
 
 # Generate documentation
-Rake::RDocTask.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include("*.rdoc", "lib/**/*.rb")
-  rd.rdoc_dir = "rdoc"
-end
-
-
-begin
-  require "rcov/rcovtask"
-
-  desc "Create a code coverage report"
-  Rcov::RcovTask.new do |t|
-    t.test_files = FileList["test/**/*_test.rb"]
-    t.ruby_opts << "-Itest -x mocha,rcov,Rakefile"
-    t.verbose = true
-  end
-rescue LoadError
-  task :clobber_rcov
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("*.rdoc", "lib/**/*.rb")
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.generator = 'hanna'
 end
 
 

data/lib/tabs_on_rails/action_controller.rb

@@ -17,14 +17,13 @@
 module TabsOnRails
 
   module ActionController
+    extend ActiveSupport::Concern
 
-    def self.included(base)
-      base.extend     ClassMethods
-      base.class_eval do
-        include       InstanceMethods
-        helper        HelperMethods
-        helper_method :current_tab, :current_tab?
-      end
+    included do
+      extend        ClassMethods
+      include       InstanceMethods
+      helper        HelperMethods
+      helper_method :current_tab, :current_tab?
     end
 
     module ClassMethods
@@ -67,20 +66,23 @@ module TabsOnRails
       protected
 
         # Sets the value for current tab to given name.
-        # If you need to manage multiple tabs, then you can pass an optional namespace.
+        # If you need to manage multiple tabs,
+        # then you can pass an optional namespace.
         #
         # Examples
         #
         #   set_tab :homepage
         #   set_tab :dashboard, :menu
         #
+        # Returns nothing.
         def set_tab(name, namespace = nil)
           tab_stack[namespace || :default] = name
         end
 
         # Returns the value for current tab in the default namespace,
         # or nil if no tab has been set before.
-        # You can pass <tt>namespace</tt> to get the value of current tab for a different namespace.
+        # You can pass <tt>namespace</tt> to get the value
+        # of the current tab for a different namespace.
         #
         # Examples
         #
@@ -93,11 +95,15 @@ module TabsOnRails
         #   current_tab           # => :homepage
         #   current_tab :menu     # => :dashboard
         #
+        # Returns the String/Symbol current tab.
         def current_tab(namespace = nil)
           tab_stack[namespace || :default]
         end
 
-        # Returns whether the current tab in <tt>namespace</tt> matches <tt>name</tt>.
+        # Checks if the current tab in <tt>namespace</tt>
+        # matches <tt>name</tt>.
+        #
+        # Returns a Boolean.
         def current_tab?(name, namespace = nil)
           current_tab(namespace).to_s == name.to_s
         end
@@ -105,6 +111,8 @@ module TabsOnRails
         # Initializes and/or returns the tab stack.
         # You won't probably need to use this method directly
         # unless you are trying to hack the plugin architecture.
+        #
+        # Returns the Hash stack.
         def tab_stack
           @tab_stack ||= {}
         end

data/lib/tabs_on_rails/railtie.rb

@@ -16,23 +16,13 @@
 
 module TabsOnRails
 
-  if defined? Rails::Railtie
-    class Railtie < ::Rails::Railtie
-      # initializer "tabs_on_rails.initialize" do
-      #   ActiveSupport.on_load :action_controller do
-      #     ::ActionController::Base.send :include, TabsOnRails::ActionController
-      #   end
-      # end
+  class Railtie < Rails::Railtie
+    initializer "tabs_on_rails.initialize" do
     end
   end
 
 end
 
-require "active_support"
-require "action_controller"
-
-# There should be a better way to do this!
-# I can't rely on Railtie#initializer because TabsOnRails::ActionController
-# provides class methods which should be available when the class
-# is evaluated.
-ActionController::Base.send :include, TabsOnRails::ActionController
+ActiveSupport.on_load(:action_controller) do
+  include TabsOnRails::ActionController
+end

data/lib/tabs_on_rails/tabs.rb

@@ -1,8 +1,8 @@
-# 
+#
 # = Tabs on Rails
 #
 # A simple Ruby on Rails plugin for creating and managing Tabs.
-# 
+#
 #
 # Category::    Rails
 # Package::     TabsOnRails
@@ -37,11 +37,15 @@ module TabsOnRails
         end                                               #   end
       end                                                 # end
     end
-    
-    def method_missing(*args)
-      @builder.tab_for(*args)
+
+    def method_missing(*args, &block)
+      @builder.tab_for(*args, &block)
     end
 
+
+    # Renders the tab stack using the current builder.
+    #
+    # Returns the String HTML content.
     def render(&block)
       raise LocalJumpError, "no block given" unless block_given?
 

data/lib/tabs_on_rails/tabs/builder.rb

@@ -1,8 +1,8 @@
-# 
+#
 # = Tabs on Rails
 #
 # A simple Ruby on Rails plugin for creating and managing Tabs.
-# 
+#
 #
 # Category::    Rails
 # Package::     TabsOnRails
@@ -17,14 +17,14 @@
 module TabsOnRails
   class Tabs
 
-    # 
+    #
     # = Builder
     #
     # The Builder class represents the interface for any custom Builder.
-    # 
+    #
     # To create a custom Builder, extend this class
     # and implement the following abstract methods:
-    # 
+    #
     # * <tt>tab_for</tt>
     #
     # Optionally, you can override the following methods to customize
@@ -48,11 +48,11 @@ module TabsOnRails
       # Returns true if +tab+ is the +current_tab+.
       #
       # Examples
-      # 
+      #
       #   class MyController < ApplicationController
       #     tab :foo
       #   end
-      # 
+      #
       #   current_tab? :foo   # => true
       #   current_tab? 'foo'  # => true
       #   current_tab? :bar   # => false

data/lib/tabs_on_rails/tabs/tabs_builder.rb

@@ -1,8 +1,8 @@
-# 
+#
 # = Tabs on Rails
 #
 # A simple Ruby on Rails plugin for creating and managing Tabs.
-# 
+#
 #
 # Category::    Rails
 # Package::     TabsOnRails
@@ -19,22 +19,22 @@ module TabsOnRails
 
     #
     # = Tabs Builder
-    # 
+    #
     # The TabsBuilder is and example of custom Builder.
     #
     class TabsBuilder < Builder
 
       # Returns a link_to +tab+ with +name+ and +options+ if +tab+ is not the current tab,
       # a simple tab name wrapped by a span tag otherwise.
-      # 
+      #
       #   current_tab? :foo   # => true
-      # 
+      #
       #   tab_for :foo, 'Foo', foo_path
       #   # => "<li class="current"><span>Foo</span></li>"
-      # 
+      #
       #   tab_for :bar, 'Bar', bar_path
       #   # => "<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.
       #

data/lib/tabs_on_rails/version.rb

@@ -20,7 +20,7 @@ module TabsOnRails
   module Version
     MAJOR = 2
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join(".")

data/tabs_on_rails.gemspec

@@ -2,37 +2,39 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tabs_on_rails}
-  s.version = "2.0.1"
+  s.version = "2.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Simone Carletti"]
-  s.date = %q{2011-02-13}
-  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.authors = [%q{Simone Carletti}]
+  s.date = %q{2011-06-29}
+  s.description = %q{TabsOnRails is a simple Rails plugin for creating tabs and navigation menus.}
   s.email = %q{weppos@weppos.net}
-  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc"]
-  s.files = ["Rakefile", "LICENSE", "init.rb", ".gemtest", "CHANGELOG.rdoc", "README.rdoc", "tabs_on_rails.gemspec", "lib/tabs_on_rails/action_controller.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", "test/tabs_on_rails/controller_mixin_test.rb", "test/tabs_on_rails/tabs/builder_test.rb", "test/tabs_on_rails/tabs/tabs_builder_test.rb", "test/tabs_on_rails/tabs_test.rb", "test/test_helper.rb", "test/views/working/default.html.erb", "test/views/working/with_item_options.html.erb", "test/views/working/with_open_close_tabs.html.erb"]
+  s.extra_rdoc_files = [%q{CHANGELOG.rdoc}, %q{README.rdoc}]
+  s.files = [%q{Rakefile}, %q{LICENSE}, %q{init.rb}, %q{.gemtest}, %q{CHANGELOG.rdoc}, %q{README.rdoc}, %q{tabs_on_rails.gemspec}, %q{lib/tabs_on_rails}, %q{lib/tabs_on_rails/action_controller.rb}, %q{lib/tabs_on_rails/railtie.rb}, %q{lib/tabs_on_rails/tabs}, %q{lib/tabs_on_rails/tabs/builder.rb}, %q{lib/tabs_on_rails/tabs/tabs_builder.rb}, %q{lib/tabs_on_rails/tabs.rb}, %q{lib/tabs_on_rails/version.rb}, %q{lib/tabs_on_rails.rb}, %q{test/test_helper.rb}, %q{test/unit}, %q{test/unit/controller_mixin_test.rb}, %q{test/unit/tabs}, %q{test/unit/tabs/block_builder_test.rb}, %q{test/unit/tabs/builder_test.rb}, %q{test/unit/tabs/tabs_builder_test.rb}, %q{test/unit/tabs_test.rb}, %q{test/views}, %q{test/views/working}, %q{test/views/working/default.html.erb}, %q{test/views/working/with_item_block.html.erb}, %q{test/views/working/with_item_options.html.erb}, %q{test/views/working/with_open_close_tabs.html.erb}]
   s.homepage = %q{http://www.simonecarletti.com/code/tabs_on_rails}
-  s.rdoc_options = ["--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
-  s.summary = %q{A simple Ruby on Rails plugin for creating and managing Tabs.}
+  s.rdoc_options = [%q{--main}, %q{README.rdoc}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.3}
+  s.summary = %q{A simple Ruby on Rails plugin for creating tabs and navigation menus.}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<rails>, ["= 3.0.3"])
+      s.add_development_dependency(%q<hanna-nouveau>, [">= 0"])
+      s.add_development_dependency(%q<rails>, ["~> 3.0.6"])
       s.add_development_dependency(%q<mocha>, ["~> 0.9.10"])
     else
       s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<rails>, ["= 3.0.3"])
+      s.add_dependency(%q<hanna-nouveau>, [">= 0"])
+      s.add_dependency(%q<rails>, ["~> 3.0.6"])
       s.add_dependency(%q<mocha>, ["~> 0.9.10"])
     end
   else
     s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<rails>, ["= 3.0.3"])
+    s.add_dependency(%q<hanna-nouveau>, [">= 0"])
+    s.add_dependency(%q<rails>, ["~> 3.0.6"])
     s.add_dependency(%q<mocha>, ["~> 0.9.10"])
   end
 end

data/test/test_helper.rb

@@ -1,6 +1,3 @@
-require 'rubygems'
-require 'bundler/setup'
-
 require 'test/unit'
 require 'mocha'
 

data/test/{tabs_on_rails → unit}/controller_mixin_test.rb

@@ -113,6 +113,18 @@ class WorkingMixinTestController < ActionController::Base
       end
     end
 
+
+  class BlockBuilder < TabsOnRails::Tabs::TabsBuilder
+    def tab_for(tab, name, options, item_options = {}, &block)
+      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
+      content += @context.capture(&block) if block_given?
+      @context.content_tag(:li, content, item_options)
+    end
+  end
+
 end
 
 class WorkingMixinTest < ActionController::TestCase
@@ -142,6 +154,15 @@ class WorkingMixinTest < ActionController::TestCase
 </ul>}, @response.body)
   end
 
+  def test_render_with_item_block
+    get :action_dashboard, :template => "with_item_block"
+    assert_dom_equal(%Q{<ul>
+  <li class="custom current"><span>Dashboard</span></li>
+  <li class="custom"><a href="/w">Welcome</a>
+  <img src="#image" />
+</li></ul>}, @response.body)
+  end
+
 
   def test_set_tab
     get :action_dashboard

data/test/unit/tabs/block_builder_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class BlockBuilderTest < ActionView::TestCase
+  tests TabsOnRails::ActionController::HelperMethods
+
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::UrlHelper
+
+  def current_tab(namespace)
+    case namespace
+      when nil, :default
+        :dashboard
+      when :foospace
+        :footab
+      else
+        :elsetab
+    end
+  end
+
+  class BlockBuilder < TabsOnRails::Tabs::TabsBuilder
+    def tab_for(tab, name, options, item_options = {}, &block)
+      item_options[:class] = item_options[:class].to_s.split(" ").push("current").join(" ") if current_tab?(tab)
+      content  = @context.link_to(name, options)
+      content += @context.capture(&block) if block_given?
+      @context.content_tag(:li, content, item_options)
+    end
+  end
+
+  def setup
+    @klass    = BlockBuilder
+    @builder  = @klass.new(self)
+  end
+
+  def test_tab_for_with_block
+    expected = %Q{<li class="current"><a href="http://dashboard.com/">Foo Bar</a><p>More Content</p></li>}
+    actual = @builder.tab_for(:dashboard, 'Foo Bar', 'http://dashboard.com/') do
+      content_tag(:p, "More Content")
+    end
+
+    assert_dom_equal expected, actual
+  end
+end

data/test/{tabs_on_rails → unit}/tabs/builder_test.rb

@@ -27,7 +27,7 @@ class BuilderTest < ActiveSupport::TestCase
   def test_initialize_without_context
     assert_raise(ArgumentError) { TabsOnRails::Tabs::Builder.new }
   end
-  
+
   def test_initialize_with_context
     assert_nothing_raised { TabsOnRails::Tabs::Builder.new(@template) }
   end

data/test/{tabs_on_rails → unit}/tabs_test.rb

@@ -30,6 +30,15 @@ class TabsTest < ActiveSupport::TestCase
     end
   end
 
+  BlockBuilder = Class.new(TabsOnRails::Tabs::Builder) do
+    def tab_for(tab, name, options, item_options = {}, &block)
+      item_options[:class] = item_options[:class].to_s.split(" ").push("current").join(" ") if current_tab?(tab)
+      content  = @context.link_to(name, options)
+      content += @context.capture(&block) if block_given?
+      @context.content_tag(:li, content, item_options)
+    end
+  end
+
 
   def setup
     @template = Template.new
@@ -83,4 +92,10 @@ class TabsTest < ActiveSupport::TestCase
     end
   end
 
+
+  def test_tab_for
+    assert_equal %Q{<li><a href="#">Welcome</a></li>},
+                 @tabs.welcome('Welcome', '#')
+  end
+
 end

data/test/views/working/with_item_block.html.erb

@@ -0,0 +1,6 @@
+<%= tabs_tag(:builder => WorkingMixinTestController::BlockBuilder) do |tabs| %>
+  <%= tabs.dashboard 'Dashboard', '/d', :class => "custom" %>
+  <%= tabs.welcome 'Welcome', '/w', :class => "custom" do %>
+  <img src="#image" />
+  <% end %>
+<% end %>

metadata

@@ -2,7 +2,7 @@
 name: tabs_on_rails
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors: 
 - Simone Carletti
@@ -10,12 +10,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-13 00:00:00 +01:00
-default_executable: 
+date: 2011-06-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -23,30 +21,42 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rails
-  prerelease: false
+  name: hanna-nouveau
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.0.3
+        version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
+  name: rails
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.9.10
+        version: 3.0.6
   type: :development
+  prerelease: false
   version_requirements: *id003
-description: "    TabsOnRails is a simple Ruby on Rails plugin for creating and managing Tabs.     It provides helpers for creating tabs with a flexible interface.\n"
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: TabsOnRails is a simple Rails plugin for creating tabs and navigation menus.
 email: weppos@weppos.net
 executables: []
 
@@ -70,15 +80,16 @@ files:
 - lib/tabs_on_rails/tabs.rb
 - lib/tabs_on_rails/version.rb
 - lib/tabs_on_rails.rb
-- test/tabs_on_rails/controller_mixin_test.rb
-- test/tabs_on_rails/tabs/builder_test.rb
-- test/tabs_on_rails/tabs/tabs_builder_test.rb
-- test/tabs_on_rails/tabs_test.rb
 - test/test_helper.rb
+- test/unit/controller_mixin_test.rb
+- test/unit/tabs/block_builder_test.rb
+- test/unit/tabs/builder_test.rb
+- test/unit/tabs/tabs_builder_test.rb
+- test/unit/tabs_test.rb
 - test/views/working/default.html.erb
+- test/views/working/with_item_block.html.erb
 - test/views/working/with_item_options.html.erb
 - test/views/working/with_open_close_tabs.html.erb
-has_rdoc: true
 homepage: http://www.simonecarletti.com/code/tabs_on_rails
 licenses: []
 
@@ -103,9 +114,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.3
 signing_key: 
 specification_version: 3
-summary: A simple Ruby on Rails plugin for creating and managing Tabs.
+summary: A simple Ruby on Rails plugin for creating tabs and navigation menus.
 test_files: []