tabs_on_rails 0.8.1

data/lib/tabs_on_rails/tabs.rb

@@ -0,0 +1,136 @@
+# 
+# = Tabs on Rails
+#
+# A simple Ruby on Rails plugin for creating and managing Tabs.
+# 
+#
+# Category::    Rails
+# Package::     TabsOnRails
+# Author::      Simone Carletti <weppos@weppos.net>
+# License::     MIT License
+#
+#--
+#
+#++
+
+
+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:
+    # 
+    # * tab_for(args)
+    #
+    class Builder
+      
+      # Initializes a new builder with +context+.
+      #
+      # Note. You should not overwrite this method to prevent incompatibility with future versions.
+      def initialize(context, options = {})
+        @context   = context
+        @namespace = options.delete(:namespace) || :default
+      end
+      
+      # 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
+      #   current_tab? 'bar'  # => false
+      #
+      def current_tab?(tab)
+        tab.to_s == @context.current_tab(@namespace).to_s
+      end
+
+      
+      # Creates and returns a tab with given +args+.
+      # 
+      # ==== Raises
+      # 
+      # NotImplemented:: you should implement this method in your custom Builder.
+      # 
+      def tab_for(*args)
+        raise NotImplementedError
+      end
+      
+      # Overwrite this method to use a custom open tag for your tabs.
+      def open_tabs
+      end
+      
+      # Overwrite this method to use a custom close tag for your tabs.
+      def close_tabs
+      end
+      
+    end
+    
+    #
+    # = Tabs Builder
+    # 
+    # The TabsBuilder is and example of custom Builder.
+    # It creates a new tab
+    #
+    class TabsBuilder < Builder
+      
+      # Implements Builder#tab_for.
+      # 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><span>Foo</span></li>
+      # 
+      #   tab_for :bar, 'Bar', bar_path
+      #   # => <li><a href="/link/to/bar">Bar</a></li>
+      # 
+      def tab_for(tab, name, options)
+        content = @context.link_to_unless(current_tab?(tab), name, options) do
+          @context.content_tag(:span, name)
+        end
+        @context.content_tag(:li, content)
+      end
+      
+      # Implements Builder#open_tabs.
+      def open_tabs
+        '<ul>'
+      end
+      
+      # Implements Builder#close_tabs.
+      def close_tabs
+        '</ul>'
+      end
+      
+    end
+    
+
+    def initialize(context, options = {}, &block)
+      @context = context
+      @builder = (options.delete(:builder) || TabsBuilder).new(@context, options)
+    end
+    
+    %w(open_tabs close_tabs).each do |method|
+      define_method(method) do
+        @builder.send(method)
+      end
+    end
+    
+    def method_missing(*args)
+      @builder.tab_for(*args)
+    end
+    
+  end
+
+end

data/lib/tabs_on_rails/version.rb

@@ -0,0 +1,31 @@
+# 
+# = Tabs on Rails
+#
+# A simple Ruby on Rails plugin for creating and managing Tabs.
+# 
+#
+# Category::    Rails
+# Package::     TabsOnRails
+# Author::      Simone Carletti <weppos@weppos.net>
+# License::     MIT License
+#
+#--
+#
+#++
+
+
+module TabsOnRails
+
+  module Version
+    MAJOR = 0
+    MINOR = 8
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+
+  VERSION         = Version::STRING
+  STATUS          = 'beta'
+  BUILD           = ''.match(/(\d+)/).to_a.first
+
+end

data/lib/tabs_on_rails.rb

@@ -0,0 +1,28 @@
+# 
+# = Tabs on Rails
+#
+# A simple Ruby on Rails plugin for creating and managing Tabs.
+# 
+#
+# Category::    Rails
+# Package::     TabsOnRails
+# Author::      Simone Carletti <weppos@weppos.net>
+# License::     MIT License
+#
+#--
+# 
+#++
+
+
+require 'tabs_on_rails/controller_mixin'
+require 'tabs_on_rails/tabs'
+require 'tabs_on_rails/version'
+
+
+module TabsOnRails
+  
+  NAME            = 'Tabs on Rails'
+  GEM             = 'tabs_on_rails'
+  AUTHOR          = 'Simone Carletti <weppos@weppos.net>'
+  
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'tabs_on_rails'
+
+ActionController::Base.send :include, TabsOnRails::ControllerMixin
+
+RAILS_DEFAULT_LOGGER.info("** TabsOnRails: initialized properly") if defined?(RAILS_DEFAULT_LOGGER)

data/tabs_on_rails.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tabs_on_rails}
+  s.version = "0.8.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Simone Carletti"]
+  s.date = %q{2009-10-09}
+  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", "lib/tabs_on_rails/controller_mixin.rb", "lib/tabs_on_rails/tabs.rb", "lib/tabs_on_rails/version.rb", "lib/tabs_on_rails.rb", "LICENSE.rdoc", "README.rdoc"]
+  s.files = ["CHANGELOG.rdoc", "init.rb", "install.rb", "lib/tabs_on_rails/controller_mixin.rb", "lib/tabs_on_rails/tabs.rb", "lib/tabs_on_rails/version.rb", "lib/tabs_on_rails.rb", "LICENSE.rdoc", "Manifest", "rails/init.rb", "Rakefile", "README.rdoc", "tabs_on_rails.gemspec", "tasks/tabs_on_rails_tasks.rake", "test/builder_test.rb", "test/controller_mixin_helpers_test.rb", "test/controller_mixin_test.rb", "test/controller_mixin_with_controller_test.rb", "test/fixtures/mixin/standard.html.erb", "test/tabs_builder_test.rb", "test/tabs_on_rails_test.rb", "test/test_helper.rb", "uninstall.rb"]
+  s.homepage = %q{http://code.simonecarletti.com/tabsonrails}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Tabs_on_rails", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{A simple Ruby on Rails plugin for creating and managing Tabs.}
+  s.test_files = ["test/builder_test.rb", "test/controller_mixin_helpers_test.rb", "test/controller_mixin_test.rb", "test/controller_mixin_with_controller_test.rb", "test/tabs_builder_test.rb", "test/tabs_on_rails_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, [">= 0.8"])
+      s.add_development_dependency(%q<echoe>, [">= 3.1"])
+    else
+      s.add_dependency(%q<rake>, [">= 0.8"])
+      s.add_dependency(%q<echoe>, [">= 3.1"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0.8"])
+    s.add_dependency(%q<echoe>, [">= 3.1"])
+  end
+end

data/tasks/tabs_on_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tabs_on_rails do
+#   # Task goes here
+# end

data/test/builder_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+class BuilderTemplate
+  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
+end
+
+
+class BuilderTest < ActiveSupport::TestCase
+  
+  def setup
+    @template = BuilderTemplate.new
+  end
+  
+
+  def test_initialize_should_require_context
+    assert_raise(ArgumentError) { TabsOnRails::Tabs::Builder.new }
+    assert_nothing_raised { TabsOnRails::Tabs::Builder.new(@template) }
+  end
+  
+  def test_initialize_should_allow_options
+    assert_nothing_raised { TabsOnRails::Tabs::Builder.new(@template, { :namespace => 'foonamespace' }) }
+  end
+
+  def test_initialize_should_set_context
+    @builder  = TabsOnRails::Tabs::Builder.new(@template)
+    assert_equal(@template, @builder.instance_variable_get(:'@context'))
+  end
+
+  def test_initialize_should_set_namespace
+    @builder  = TabsOnRails::Tabs::Builder.new(@template)
+    assert_equal(:default, @builder.instance_variable_get(:'@namespace'))
+
+    @builder  = TabsOnRails::Tabs::Builder.new(@template, :namespace => :foobar)
+    assert_equal(:foobar, @builder.instance_variable_get(:'@namespace'))
+  end
+
+
+  def test_current_tab
+    @builder  = TabsOnRails::Tabs::Builder.new(@template)
+    assert( @builder.current_tab?(:dashboard))
+    assert( @builder.current_tab?('dashboard'))
+    assert(!@builder.current_tab?(:welcome))
+    assert(!@builder.current_tab?('welcome'))
+  end
+
+  def test_current_tab_with_namespace
+    @builder  = TabsOnRails::Tabs::Builder.new(@template, :namespace => :foospace)
+    assert( @builder.current_tab?(:footab))
+    assert( @builder.current_tab?('footab'))
+    assert(!@builder.current_tab?(:dashboard))
+    assert(!@builder.current_tab?('dashboard'))
+  end
+
+
+  def test_open_tabs
+    @builder  = TabsOnRails::Tabs::Builder.new(@template)
+    assert_equal(nil, @builder.open_tabs)
+  end
+
+  def test_close_tabs
+    @builder  = TabsOnRails::Tabs::Builder.new(@template)
+    assert_equal(nil, @builder.close_tabs)
+  end
+
+
+  def test_tab_for_should_raise_not_implemented_error
+    @builder  = TabsOnRails::Tabs::Builder.new(@template)
+    assert_raise(NotImplementedError) { @builder.tab_for }
+    assert_raise(NotImplementedError) { @builder.tab_for('foo') }
+    assert_raise(NotImplementedError) { @builder.tab_for('foo', 'bar') }
+  end
+  
+end

data/test/controller_mixin_helpers_test.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+
+class MockBuilder < TabsOnRails::Tabs::Builder
+
+  def initialize_with_mocha(*args)
+    checkpoint
+    initialize_without_mocha(*args)
+  end
+  alias_method_chain :initialize, :mocha
+
+  def checkpoint
+  end
+
+  def tab_for(tab, name, *args)
+  end
+
+end
+
+class NilBoundariesBuilder < TabsOnRails::Tabs::Builder
+  def tab_for(tab, name, *args)
+    @context.content_tag(:span, name)
+  end
+end
+
+class NilOpenBoundaryBuilder < NilBoundariesBuilder
+  def close_tabs
+    '<br />'
+  end
+end
+
+class NilCloseBoundaryBuilder < NilBoundariesBuilder
+  def open_tabs
+    '<br />'
+  end
+end
+
+
+class ControllerMixinHelpersTest < ActionView::TestCase
+  tests TabsOnRails::ControllerMixin::HelperMethods
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::UrlHelper
+
+
+  def test_tabs_tag_should_raise_local_jump_error_without_block
+    assert_raise(LocalJumpError) { tabs_tag }
+  end
+  
+  def test_tabs_tag_with_builder
+    MockBuilder.any_instance.expects(:checkpoint).once
+    tabs_tag(:builder => MockBuilder) {}
+  end
+
+  def test_tabs_tag_with_namespace
+    MockBuilder.any_instance.expects(:checkpoint).once
+    tabs_tag(:builder => MockBuilder, :namespace => :custom) do |tabs|
+      builder = tabs.instance_variable_get(:'@builder')
+      assert_equal(:custom, builder.instance_variable_get(:'@namespace'))
+    end
+  end
+
+
+  def test_tabs_tag_should_not_concat_open_close_tabs_when_nil
+    content = tabs_tag(:builder => NilBoundariesBuilder) do |t| 
+      concat t.single('Single', '#')
+    end
+    
+    assert_dom_equal('<span>Single</span>', content)
+  end
+  
+  def test_tabs_tag_should_not_concat_open_tabs_when_nil
+    content = tabs_tag(:builder => NilOpenBoundaryBuilder) do |t|
+      concat t.single('Single', '#')
+    end
+    
+    assert_dom_equal('<span>Single</span><br />', content)
+  end
+  
+  def test_tabs_tag_should_not_concat_close_tabs_when_nil
+    content = tabs_tag(:builder => NilCloseBoundaryBuilder) do |t|
+      concat t.single('Single', '#')
+    end
+
+    assert_dom_equal('<br /><span>Single</span>', content)
+  end
+
+end

data/test/controller_mixin_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+class ControllerMixinTest < ActionController::TestCase
+  include ControllerTestHelpers
+
+  class MixinController < ActionController::Base
+  end
+
+  def setup
+    @controller       = MixinController.new
+    @controller_proxy = ControllerProxy.new(@controller)
+    @request          = ActionController::TestRequest.new
+    @response         = ActionController::TestResponse.new
+  end
+
+  
+  def test_set_tab
+    controller.set_tab :footab
+    assert_equal(:footab, controller.tab_stack[:default])
+  end
+
+  def test_set_tab_with_namespace
+    controller.set_tab :footab, :namespace
+    assert_equal(:footab, controller.tab_stack[:namespace])
+  end
+
+  def test_set_tab_with_default_namespace
+    controller.set_tab :footab, :default
+    assert_equal(:footab, controller.tab_stack[:default])
+  end
+
+  def test_set_tab_with_and_without_namespace
+    controller.set_tab :firsttab
+    controller.set_tab :secondtab, :custom
+    assert_equal(:firsttab, controller.tab_stack[:default])
+    assert_equal(:secondtab, controller.tab_stack[:custom])
+  end
+
+
+  def test_current_tab
+    controller.tab_stack[:default] = :mytab
+    assert_equal(:mytab, controller.current_tab)
+  end
+
+  def test_current_tab_with_namespace
+    controller.tab_stack[:namespace] = :mytab
+    assert_equal(:mytab, controller.current_tab(:namespace))
+  end
+
+  def test_current_tab_with_default_namespace
+    controller.tab_stack[:default] = :mytab
+    assert_equal(:mytab, controller.current_tab(:default))
+  end
+
+  def test_set_tab_with_and_without_namespace
+    controller.tab_stack[:default] = :firsttab
+    controller.tab_stack[:custom] = :secondtab
+    assert_equal(:firsttab, controller.current_tab(:default))
+    assert_equal(:secondtab, controller.current_tab(:custom))
+  end
+
+
+  def test_current_tab_question
+    controller.tab_stack[:default] = :mytab
+    assert( controller.current_tab?(:mytab))
+    assert(!controller.current_tab?(:yourtab))
+  end
+
+  def test_current_tab_question_with_namespace
+    controller.tab_stack[:custom] = :mytab
+    assert( controller.current_tab?(:mytab, :custom))
+    assert(!controller.current_tab?(:yourtab, :custom))
+  end
+
+  def test_current_tab_question_with_default_namespace
+    controller.tab_stack[:default] = :mytab
+    assert( controller.current_tab?(:mytab, :default))
+    assert(!controller.current_tab?(:yourtab, :default))
+  end
+
+  def test_current_tab_question_with_and_without_namespace
+    controller.tab_stack[:default] = :firsttab
+    controller.tab_stack[:custom] = :secondtab
+    assert( controller.current_tab?(:firsttab, :default))
+    assert(!controller.current_tab?(:secondtab, :default))
+    assert( controller.current_tab?(:secondtab, :custom))
+    assert(!controller.current_tab?(:firsttab, :custom))
+  end
+
+end