weppos-tabs_on_rails 0.1.0 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,5 +1,15 @@
 = Changelog
 
+
+== Release 0.2.0
+
+* ADDED: The README file is definitely more useful now, filled up with some basic documentation.
+
+* CHANGED: Use the standard way to initialize a Rails plugin when packaged as a GEM (closes #146).
+
+* CHANGED: Removed development version warning (closes #145).
+
+
 == Release 0.1.0
 
 * Initial version

data/README.rdoc

@@ -3,8 +3,156 @@
 TabsOnRails is a simple Rails plugin for creating and managing Tabs.
 It provides helpers for creating tabs with a flexible interface.
 
-*WARNING*: This library has not been released yet. 
-This package seems stable, but should be considered a development release.
 
+== Rails Installation
 
-Copyright (c) 2009 Simone Carletti, released under the MIT license
+=== As a Gem
+
+This is the preferred way to install TabsOnRails and the best way if you want install a stable version.
+You can specify the GEM dependency in your application environment.rb file:
+
+  Rails::Initializer.run do |config|
+    
+    # other configurations
+    
+    config.gem "weppos-tabs_on_rails", :lib => "tabs_on_rails", :source => "http://gems.github.com"
+  end
+
+
+=== As a Plugin
+
+This is the preferred way if you want to live on the edge and install a development version.
+
+  $ script/plugin install git://github.com/weppos/tabs_on_rails.git
+
+
+== Quick Start
+
+In your template use the <tt>tabs_tag</tt> helper to create your tab.
+
+  <% tabs_tab do |tab| %>
+    <%= tab.home, 'Homepage', root_path %>
+    <%= tab.dashboard, 'Dashboard', dashboard_path %>
+    <%= tab.account, 'Account', account_path %>
+  <% end %>
+
+The example above produces the following HTML output.
+
+  <ul>
+    <li><a href="/">Homepage</a></li>
+    <li><a href="/dashboard">Dashboard</a></li>
+    <li><a href="/account">Account</a></li>
+  </ul>
+
+The usage is similar to the Rails route file.
+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.
+
+  class DashboardController < ApplicationController
+    current_tab :dashboard
+  end
+
+Now, if the action belongs to DashboardController, the template will automatically render the following HTML code.
+
+  <ul>
+    <li><a href="/">Homepage</a></li>
+    <li><span>Dashboard</span></li>
+    <li><a href="/account">Account</a></li>
+  </ul>
+
+
+== Restricting current_tab scope
+
+The <tt>current_tab</tt> method understands all options you are used to pass to a Rails controller filter.
+In fact, behind the scenes this method uses a <tt>before_filter</tt> to set a special <tt>@current_tab</tt> variable.
+
+Taking advantage of Rails filter options, you can restrict a tab to a selected group of actions in the same controller.
+
+  class PostsController < ApplicationController
+    current_tab :admin
+    current_tab :posts, :only => [ :index, :show ]
+  end
+  
+  class ApplicationController < ActionController::Base
+    current_tab :admin, :if => :admin_controller?
+    
+    def admin_controller?
+      self.class.name =~ /^Admin(::|Controller)/
+    end
+  end
+
+
+== Tab Builders
+
+The <tt>Builder</tt> is responsible for creating the tabs HTML code. This library is bundled with two <tt>Builders</tt>:
+
+<tt>Tabs::Builder</tt>:: this is the abstract interface for any custom builder.
+<tt>Tabs::TabsBuilder</tt>:: this is the default builder.
+
+=== Understanding the Builder
+
+Builders act as formatters. A Builder incapsulates all the logic behind the tab creation including the code required to toggle tabs status.
+
+When the <tt>tabs_tag</tt> helper is called, it creates a new <tt>Tabs</tt> instance with selected Builder.
+If you don't provide a custom builder, then <tt>Tabs::TabsBuilder</tt> is used by default.
+
+=== Creating a custom Builder
+
+All builders must extend the base <tt>Tabs::Builder</tt> class and implement at least the <tt>tab_for</tt> method.
+Additional overridable methods include:
+
+<tt>open_tabs</tt>:: the method called before the tab set
+<tt>close_tabs</tt>:: the method called after the tab set
+<tt>tab_for</tt>:: the method called to create a single tab item
+
+The following example creates a custom tab builder called MainTabBuilder.
+
+  class MenuTabBuilder < TabsOnRails::Tabs::Builder
+    def tab_for(tab, name, options, item_options = {})
+      item_options[:class] = (current_tab?(tab) ? 'active' : '')
+      @context.content_tag(:li, item_options) do
+        @context.link_to(name, options)
+      end
+    end
+  end
+
+=== Using a custom Builder
+
+In your view, simply pass the builder class to the <tt>tabs_tag</tt> method.
+
+  <% tabs_tag(MenuTabBuilder) do |tab| %>
+    <%= tab.home, 'Homepage', root_path %>
+    <%= tab.dashboard, 'Dashboard', dashboard_path %>
+    <%= tab.account, 'Account', account_path, :style => 'float: right;' %>
+  <% end %>
+  
+This is the final result.
+
+  <ul>
+    <li class=""><a href="/">Homepage</a></li>
+    <li class="active"><a href="/dashboard">Dashboard</a></li>
+    <li class="" style="float: right;"><a href="/account">Account</a></li>
+  </ul>
+
+== Documentation
+
+The library is still under development and this README file might not be contain the latest changes.
+For the full documentation, development roadmap and more information please visit the {project page}[http://code.simonecarletti.com/wiki/tabsonrails].
+
+
+== Credits
+
+Author:: {Simone Carletti}[http://www.simonecarletti.com/] <weppos@weppos.net>
+
+
+== Resources
+
+* {Homepage}[http://code.simonecarletti.com/tabsonrails]
+* {GitHub}[http://github.com/weppos/tabs_on_rails/]
+
+
+== License
+
+Copyright (c) 2009 Simone Carletti, TabsOnRails is released under the MIT license.

data/Rakefile

@@ -8,8 +8,8 @@ require 'tabs_on_rails'
 
 PKG_NAME    = ENV['PKG_NAME']    || TabsOnRails::GEM
 PKG_VERSION = ENV['PKG_VERSION'] || TabsOnRails::VERSION
-PKG_SUMMARY = "Simple Rails plugin for creating and managing Tabs."
-PKG_FILES   = FileList.new("{lib,tasks,test}/**/*") do |files|
+PKG_SUMMARY = "A simple Ruby on Rails plugin for creating and managing Tabs."
+PKG_FILES   = FileList.new("{lib,rails,tasks,test}/**/*") do |files|
   files.include %w(*.{rdoc,rb})
   files.include %w(Rakefile)
 end
@@ -25,10 +25,10 @@ Echoe.new(PKG_NAME, PKG_VERSION) do |p|
   p.email         = "weppos@weppos.net"
   p.summary       = PKG_SUMMARY
   p.description   = <<-EOD
-    TabsOnRails is a simple Rails plugin for creating and managing Tabs. \
+    TabsOnRails is a simple Ruby on Rails plugin for creating and managing Tabs. \
     It provides helpers for creating tabs with a flexible interface.
   EOD
-  p.url           = "http://code.simonecarletti.com/tabs_on_rails"
+  p.url           = "http://code.simonecarletti.com/tabsonrails"
   p.project       = RUBYFORGE_PROJECT
 
   p.need_zip      = true
@@ -44,7 +44,7 @@ begin
   require 'code_statistics'
   desc "Show library's code statistics"
   task :stats do
-    CodeStatistics.new(["WWW::Delicious", "lib"],
+    CodeStatistics.new(["TabsOnRails", "lib"],
                        ["Tests", "test"]).to_s
   end
 rescue LoadError

data/init.rb

@@ -1 +1 @@
-ActionController::Base.send :include, TabsOnRails::ControllerMixin
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/lib/tabs_on_rails/controller_mixin.rb

@@ -1,7 +1,7 @@
 # 
 # = Tabs on Rails
 #
-# Simple Rails plugin for creating and managing Tabs.
+# A simple Ruby on Rails plugin for creating and managing Tabs.
 # 
 #
 # Category::    Rails

data/lib/tabs_on_rails/tabs.rb

@@ -1,7 +1,7 @@
 # 
 # = Tabs on Rails
 #
-# Simple Rails plugin for creating and managing Tabs.
+# A simple Ruby on Rails plugin for creating and managing Tabs.
 # 
 #
 # Category::    Rails

data/lib/tabs_on_rails/version.rb

@@ -1,7 +1,7 @@
 # 
 # = Tabs on Rails
 #
-# Simple Rails plugin for creating and managing Tabs.
+# A simple Ruby on Rails plugin for creating and managing Tabs.
 # 
 #
 # Category::    Rails
@@ -18,7 +18,7 @@ module TabsOnRails
 
   module Version
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/tabs_on_rails.rb

@@ -1,7 +1,7 @@
 # 
 # = Tabs on Rails
 #
-# Simple Rails plugin for creating and managing Tabs.
+# A simple Ruby on Rails plugin for creating and managing Tabs.
 # 
 #
 # Category::    Rails

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")

data/tabs_on_rails.gemspec

@@ -2,21 +2,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tabs_on_rails}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Simone Carletti"]
-  s.date = %q{2009-02-15}
-  s.description = %q{TabsOnRails is a simple Rails plugin for creating and managing Tabs.     It provides helpers for creating tabs with a flexible interface.}
+  s.date = %q{2009-02-17}
+  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", "Rakefile", "README.rdoc", "tasks/tabs_on_rails_tasks.rake", "test/builder_test.rb", "test/controller_mixin_helpers_test.rb", "test/controller_mixin_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", "tabs_on_rails.gemspec"]
+  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", "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/fixtures/mixin/standard.html.erb", "test/tabs_builder_test.rb", "test/tabs_on_rails_test.rb", "test/test_helper.rb", "uninstall.rb", "Manifest"]
   s.has_rdoc = true
-  s.homepage = %q{http://code.simonecarletti.com/tabs_on_rails}
+  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.1}
-  s.summary = %q{Simple Rails plugin for creating and managing Tabs.}
+  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/tabs_builder_test.rb", "test/tabs_on_rails_test.rb", "test/test_helper.rb"]
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: weppos-tabs_on_rails
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Simone Carletti
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-15 00:00:00 -08:00
+date: 2009-02-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "3.1"
     version: 
-description: TabsOnRails is a simple Rails plugin for creating and managing Tabs.     It provides helpers for creating tabs with a flexible interface.
+description: TabsOnRails is a simple Ruby on Rails plugin for creating and managing Tabs.     It provides helpers for creating tabs with a flexible interface.
 email: weppos@weppos.net
 executables: []
 
@@ -55,9 +55,10 @@ files:
 - 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
@@ -67,9 +68,9 @@ files:
 - test/tabs_on_rails_test.rb
 - test/test_helper.rb
 - uninstall.rb
-- tabs_on_rails.gemspec
+- Manifest
 has_rdoc: true
-homepage: http://code.simonecarletti.com/tabs_on_rails
+homepage: http://code.simonecarletti.com/tabsonrails
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -98,7 +99,7 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Simple Rails plugin for creating and managing Tabs.
+summary: A simple Ruby on Rails plugin for creating and managing Tabs.
 test_files: 
 - test/builder_test.rb
 - test/controller_mixin_helpers_test.rb