rubyguy-simple_tabs 0.1.0

data/README.rdoc

@@ -0,0 +1,83 @@
+= SimpleTabs
+
+Super simple plugin/gem to easily add tabbed navigation to your Ruby on Rails application.
+
+== Installation
+
+=== As RubyGem:
+
+In config/environment.rb:
+
+  config.gem 'rubyguy-simple_tabs', :version => '0.1.0', :source => 'http://gems.github.com/', :lib => 'simple_tabs'
+
+And then run:
+
+  rake gems:install
+
+=== As Rails plugin:
+
+  script/plugin install git://github.com/rubyguy/simple_tabs.git
+
+== Usage
+
+In your layout:
+
+  <%
+    tabbed_menu do
+      tab 'Home', :root # A tab with no children that links to root_path
+      tab 'Our products', products_path do # A tab with one child that links to products_path
+        child :controller => 'products', :action => 'show' # This tab will not only be active when we're at the index action (products_path)
+      end
+
+      tab 'About', :controller => 'about', :action => 'index' do # A tab with one child with two actions that links to AboutController#index
+        child :controller => 'about', :action => ['company', 'contact']
+      end
+    end
+  %>
+
+The output will look like this if we're at the show action of ProductsController:
+
+  <ul id="menu">
+    <li><a href="/">Home</a></li>
+    <li class="active"><a href="/products">Our products</a></li>
+    <li><a href="/about">About</a></li>
+  </ul>
+
+But if we were at the show action, the output would look like this:
+
+  <ul id="menu">
+    <li><a href="/">Home</a></li>
+    <li class="active">Our products</a></li>
+    <li><a href="/about">About</a>
+  </ul>
+
+Keep in mind:
+
+  1. A tab is active if we're at the URL of the tab it self or any of its children.
+  2. You can use symbols (:root instead of root_path) or hashes to specify URLs both in tabs and their children.
+  3. You can specify as many children for a tab as you want.
+  4. You can use arrays to (for example) specify multiple actions that will activate a child.
+  5. The link itself will be generated by the Rails helper link_to_unless_current.
+
+== License
+
+Copyright (c) 2009 David Knorr
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('simple_tabs', '0.1.0') do |p|
+  p.description    = 'Super simple plugin/gem to easily add tabbed navigation to your Ruby on Rails application.'
+  p.url            = 'http://github.com/rubyguy/simple_tabs'
+  p.author         = 'David Knorr'
+  p.email          = 'rubyguy@ymail.com'
+  p.ignore_pattern = ['tmp/*', 'script/*']
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1 @@
+require 'simple_tabs'

data/lib/simple_tabs.rb

@@ -0,0 +1,78 @@
+module SimpleTabs
+  def tabbed_menu
+    concat tag(:ul, :id => 'menu')
+    yield
+    concat('</ul>')
+  end
+
+  def tab(name, url)
+    @active = false
+    url = url_to_string(url)
+    if current_page? url
+      concat tag(:li, :class => 'active')
+    else
+      if block_given?
+        yield
+        if @active
+          concat tag(:li, :class => 'active')
+        else
+          concat tag(:li)
+        end
+      else
+        concat tag(:li)
+      end
+    end
+    concat link_to_unless_current name, url
+    concat '</li>'
+  end
+
+  def child(url)
+    return if @active
+    url = url_to_string(url) unless url.is_a?(Hash)
+    if url.all? { |value| value.is_a?(String) || value.is_a?(Symbol) }
+      if current_page?(url)
+        @active = true
+      end
+    else
+      if params_matches?(url)
+        @active = true
+      end
+    end
+  end
+
+  private
+
+  def url_to_string(url)
+    return url if url.is_a? String
+    return send("#{url}_path") if url.is_a? Symbol
+    return url_for(url) if url.is_a?(Hash) || url.is_a?(Array)
+  end
+
+  def params_matches?(url)
+    if url.all? { |key, value| params[key] == value.to_s && !value.is_a?(Array) }
+      return true
+    else
+      output = false
+      url.each do |key, value|
+        if (value.is_a?(String) || value.is_a?(Symbol)) && params[key] == value.to_s
+          output = true
+        elsif value.is_a?(Array)
+          matched = false
+          value.each do |acceptable_value|
+            if params[key] == acceptable_value.to_s
+              matched = true
+            end
+          end
+          output = false unless matched
+        else
+          output = false
+        end
+      end
+      return output
+    end
+  end
+end
+
+class ActionView::Base
+  include SimpleTabs
+end

data/simple_tabs.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_tabs}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Knorr"]
+  s.date = %q{2009-03-28}
+  s.description = %q{Super simple plugin/gem to easily add tabbed navigation to your Ruby on Rails application.}
+  s.email = %q{rubyguy@ymail.com}
+  s.extra_rdoc_files = ["lib/simple_tabs.rb", "README.rdoc"]
+  s.files = ["init.rb", "lib/simple_tabs.rb", "Rakefile", "README.rdoc", "Manifest", "simple_tabs.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/rubyguy/simple_tabs}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Simple_tabs", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{simple_tabs}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Super simple plugin/gem to easily add tabbed navigation to your Ruby on Rails application.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: rubyguy-simple_tabs
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Knorr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Super simple plugin/gem to easily add tabbed navigation to your Ruby on Rails application.
+email: rubyguy@ymail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/simple_tabs.rb
+- README.rdoc
+files: 
+- init.rb
+- lib/simple_tabs.rb
+- Rakefile
+- README.rdoc
+- Manifest
+- simple_tabs.gemspec
+has_rdoc: true
+homepage: http://github.com/rubyguy/simple_tabs
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Simple_tabs
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: simple_tabs
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Super simple plugin/gem to easily add tabbed navigation to your Ruby on Rails application.
+test_files: []
+