tabulous 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+pkg/*
+*.gem
+.bundle
+.DS_Store

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+== 0.0.1 (March 2, 2011)
+* Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in tabulous.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright 2011 Wyatt Greene
+http://techiferous.com
+
+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/README.rdoc

@@ -0,0 +1,85 @@
+= Tabulous
+
+== Description
+
+Tabulous provides an easy way to add tabs to your Rails application.
+
+== Requirements
+
+Tabulous only works with Rails 3.  It has been tested on Ruby 1.8.7 and 1.9.2.
+
+== Usage
+
+Traditionally, implementing tabs in Rails involves adding logic to your views and sprinkling
+tab-related code all over your controllers.  Tabulous takes a different approach and
+consolidates all of the tab-related code into one configuration file.  Apart from this
+configuration file, you just have to call <%= tabs %> and <%= subtabs %> in your view layout(s)
+and then create your own CSS styles for the tabs.
+
+To get started, add the gem to your Rails application's Gemfile and install it using:
+
+  bundle install
+
+Then generate the tab initializer:
+
+  rails generate tabs
+
+This will generate config/initializers/tabulous.rb.  Open the file and configure it to your liking.
+You'll notice the code is formatted into a grid.  After you edit the file, run the following rake
+task to prettify the code back into a nice grid:
+
+  rake tabs:format
+
+Make sure you call the following view helpers in your layout(s):
+
+  <%= tabs %>
+  <%= subtabs %>
+
+The tabs helper will generate markup that looks like this:
+
+  <div id="tabs">
+    <ul>
+      <li class="active enabled"><span class="tab">Explanation</span></li>
+      <li class="inactive enabled"><a href="/galaxies/elliptical_galaxies" class="tab">Galaxies</a></li>
+      <li class="inactive enabled"><a href="/exoplanets" class="tab">Planets</a></li>
+      <li class="inactive enabled"><a href="/stars" class="tab">Stars</a></li>
+      <li class="inactive disabled"><span class="tab">Asteroids</span></li>
+    </ul>
+  </div>
+
+And the subtabs helper will generate markup that looks like this:
+
+  <div id="subtabs">
+    <ul>
+      <li class="active enabled"><span class="tab">Exoplanets</span></li>
+      <li class="inactive enabled"><a href="/rogue_planets" class="tab">Rogue Planets</a></li>
+    </ul>
+  </div>
+
+Tabulous will start you off with some CSS scaffolding but you'll eventually want to create your own
+CSS. 
+
+== Examples
+
+Look in this gem's test/applications directory to find working example applications.  Look at their
+config/initializers/tabulous.rb and app/layouts/application.html.erb files.
+
+== Contributing
+
+Developers are encouraged to contribute ideas or code.
+
+To make code changes:
+
+* First, check out this gem's code from github.
+* Next, type bundle install in tabulous's directory.  This will install any gems you need
+  for developing tabulous.
+* Then go to each directory in test/applications and type bundle install.  This makes sure
+  the test applications have the gems that they need to run.
+* To save you the effort of having to create and migrate databases for each test application,
+  I've committed the sqlite databases of each test application to the repository.
+* Now go to tabulous's directory and type rake test.  If everything has been installed
+  properly, all of the tests will pass.    
+* Now you should be all set to code.
+
+Please send me a message if you find any confusing or incorrect documentation in tabulous or if
+you encounter any bugs.  Thank you and enjoy!

data/Rakefile

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'colored'
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+namespace :test do
+  Dir['test/applications/*'].each do |filename|
+    if File.directory?(filename)
+      name = filename.split('/').last
+      desc "run tests for the test application #{name}"
+      Rake::TestTask.new(name) do |t|
+        t.libs << 'lib'
+        t.libs << 'test'
+        t.pattern = "test/applications/#{name}/**/*_test.rb"
+        t.verbose = false
+      end
+    end
+  end
+  desc "run unit tests for tabulous"
+  Rake::TestTask.new(:units) do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/units/**/*_test.rb'
+    t.verbose = true
+  end
+end
+
+task :test do
+  # we cannot load more than one Rails app at a time so we run the rake tasks
+  # from the shell so that each has its own process
+  Dir['test/applications/*'].each do |filename|
+    if File.directory?(filename)
+      name = filename.split('/').last
+      puts "Running tests for test application \"#{name}\"".magenta
+      puts %x{rake test:#{name}}
+    end
+  end
+  puts "Running unit tests".magenta
+  Rake::Task['test:units'].invoke
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Test'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/tabs/USAGE

@@ -0,0 +1 @@
+This will generate tabs for your Rails app.

data/lib/generators/tabs/tabs_generator.rb

@@ -0,0 +1,13 @@
+require 'colored'
+class TabsGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+  def create_tabs_initializer_file
+    template "tabulous.rb", "config/initializers/tabulous.rb" 
+    puts
+    puts ("Tabulous made some guesses about how you want your tabs configured but " +
+          "probably got some things wrong.  So you need to edit " +
+          "config/initializers/tabulous.rb to your liking.").magenta
+    puts
+    puts "Don't forget to put <%= tabs %> and <%= subtabs %> in your layout(s).".magenta
+  end
+end

data/lib/generators/tabs/templates/tabulous.rb

@@ -0,0 +1,170 @@
+# Tabulous gives you an easy way to set up tabs for your Rails application.
+#
+#   1. Configure this initializer.
+#   2. Add <%%= tabs %> and <%%= subtabs %> in your layout(s) wherever you want
+#      your tabs to appear.
+#   3. Add styles for these tabs in your stylesheets.
+#   4. Profit!
+
+<% controllers = []
+   Dir[File.join(Rails.root.to_s, 'app/controllers/*.rb')].each do |filename|
+     filename = filename.split('/').last
+     if filename =~ /(\w+)_controller.rb/
+       controller_name = $1.downcase
+       if controller_name != 'application'
+         controllers << controller_name
+       end
+     end
+   end
+-%>
+Tabulous.setup do |config|
+
+  #---------------------------
+  #   HOW TO USE THE TABLES
+  #---------------------------
+  #
+  # The following tables are just an array of arrays.  As such, you can put
+  # any Ruby code into a cell.  For example, you could put "/foo/bar" in
+  # a path cell or you could put "/foo" + "/bar".  You can even wrap up code
+  # in a lambda to be executed later.  These will be executed in the context
+  # of a Rails view meaning they will have access to view helpers.
+  #
+  # However, there is something special about the format of these tables.
+  # Because it would be a pain for you to manually prettify the tables each
+  # time you edit them, there is a special rake task that does this for
+  # you: rake tabs:format.  However, for this prettifier to work properly
+  # you have to follow some special rules:
+  #
+  #   * No comments are allowed between rows.
+  #   * Comments are allowed to the right of rows, except for header rows.
+  #   * And most importantly: commas that separate cells should be surrounded
+  #     by spaces and commas that are within cells should not.  This gives the
+  #     formatter an easy way to distinguish between cells without having
+  #     to actually parse the Ruby.
+
+  #----------
+  #   TABS
+  #----------
+  #
+  # This is where you define your tabs and subtabs.  The order that the tabs
+  # appear in this list is the order they will appear in your views.  Any
+  # subtabs defined will have the previous tab as their parent.
+  #
+  # TAB NAME
+  #   must end in _tab or _subtab
+  # DISPLAY TEXT
+  #   the text the user sees on the tab
+  # PATH
+  #   the URL that gets sent to the server when the tab is clicked
+  # VISIBLE
+  #   whether to display the tab
+  # ENABLED
+  #   whether the tab is disabled (unclickable)
+
+<% index_routes = Rails.application.routes.routes.select{|r| r.requirements[:action] == 'index'}
+   tab_data = index_routes.map do |route|
+     name = route.requirements[:controller].gsub('/', '_')
+     { :text => name.titleize,
+       :name => name,
+       :path_helper => route.name + '_path' }
+   end
+-%>
+<%= s = []
+    s <<  '  config.tabs = ['
+    s <<  '    #-------------------------------------------------------------------------------------------------#'
+    s <<  '    #    TAB NAME         |    DISPLAY TEXT     |    PATH           |    VISIBLE?    |    ENABLED?    #'
+    s <<  '    #-------------------------------------------------------------------------------------------------#'
+    for tab in tab_data
+      s << "[    :#{tab[:name]}_tab  ,  '#{tab[:text]}'    ,  lambda { #{tab[:path_helper]} }  ,  true  ,  true  ],"
+    end
+    s <<  '    #-------------------------------------------------------------------------------------------------#'
+    s <<  '    #    TAB NAME         |    DISPLAY TEXT     |    PATH           |    VISIBLE?    |    ENABLED?    #'
+    s <<  '    #-------------------------------------------------------------------------------------------------#'
+    s <<  '  ]'
+    Tabulous::Formatter.format(s).join("\n") %>
+
+  #-------------
+  #   ACTIONS
+  #-------------
+  #
+  # This is where you hook up actions with tabs.  That way tabulous knows
+  # which tab and subtab to mark active when an action is rendered.
+  #
+  # CONTROLLER
+  #   the name of the controller
+  # ACTION
+  #   the name of the action, or :all_actions
+  # TAB
+  #   the name of the tab or subtab that is active when this action is rendered
+
+<%= s = []
+    s <<  '  config.actions = ['
+    s <<  '    #-------------------------------------------------------------#'
+    s <<  '    #    CONTROLLER    |    ACTION          |    TAB              #'
+    s <<  '    #-------------------------------------------------------------#'
+    for tab in tab_data
+      s << "[    :#{tab[:name]}  ,  :all_actions  ,  :#{tab[:name]}_tab  ],"
+    end
+    s <<  '    #-------------------------------------------------------------#'
+    s <<  '    #    CONTROLLER    |    ACTION          |    TAB              #'
+    s <<  '    #-------------------------------------------------------------#'
+    s <<  '  ]'
+    Tabulous::Formatter.format(s).join("\n") %>
+
+  #-------------
+  #   OPTIONS
+  #-------------
+
+  # By default, you cannot click on the active tab.
+  config.active_tab_clickable = false
+
+  # By default, the subtabs HTML element is not rendered if it is empty.
+  config.always_render_subtabs = false
+
+  # By default, when an action renders and no tab is defined for that action,
+  # an error is thrown.  If you turn this off, no error is thrown and the
+  # tabs are simply not rendered.
+  config.raise_error_if_no_tab_found = true
+
+  # By default, div elements are used in the tab markup.  When html5 is
+  # true, nav elements are used instead.
+  config.html5 = false
+
+  #------------
+  #   STYLES
+  #------------
+  #
+  # The markup that is generated has the following properties:
+  #
+  #   Tabs and subtabs that are selected have the class "active".
+  #   Tabs and subtabs that are not selected have the class "inactive".
+  #   Tabs that are disabled have the class "disabled"; otherwise, "enabled".
+  #   Tabs that are not visible do not appear in the markup at all.
+  #
+  # These classes are provided to make it easier for you to create your
+  # own CSS (and JavaScript) for the tabs.
+
+  # Some styles will be generated for you to get you off to a good start.
+  # Scaffolded styles are not meant to be used in production as they
+  # generate invalid HTML markup.  They are merely meant to give you a
+  # head start or an easy way to prototype quickly.
+  # 
+  config.css.scaffolding = true
+
+  # You can tweak the colors of the generated CSS.
+  #
+  # config.css.background_color = '#ccc'
+  # config.css.text_color = '#444'
+  # config.css.active_tab_color = 'white'
+  # config.css.hover_tab_color = '#ddd'
+  # config.css.inactive_tab_color = '#aaa'
+  # config.css.inactive_text_color = '#888'
+
+  #-----------
+  #   NOTES
+  #-----------
+  #
+  # In development mode this initializer is reloaded for each request so that
+  # you don't have to restart the server each time you edit this file.
+
+end

data/lib/tabulous.rb

@@ -0,0 +1,11 @@
+module Tabulous
+  require 'tabulous/railtie' if defined?(Rails)
+end
+
+require 'tabulous/errors'
+require 'tabulous/options'
+require 'tabulous/css_scaffolding'
+require 'tabulous/helpers'
+require 'tabulous/formatter'
+require 'tabulous/tab'
+require 'tabulous/tabulous'

data/lib/tabulous/css_scaffolding.rb

@@ -0,0 +1,111 @@
+module Tabulous
+  def self.embed_styles
+    return '' unless @@css.scaffolding
+    %Q{
+      <style type="text/css">
+      
+      body {
+        margin: 0;
+        padding: 0;
+      }
+      
+      #tabs, #tabs ul, #tabs ul li, #tabs ul li span, #tabs ul li a,
+      #subtabs, #subtabs ul, #subtabs ul li, #subtabs ul li span, #subtabs ul li a {
+        margin: 0;
+        padding: 0;
+        line-height: 1;
+      }
+
+      #tabs, #tabs a, #tabs a:visited, #tabs a:hover {
+        color: #{@@css.text_color};
+      }
+
+      #tabs li.disabled, #tabs li.disabled a, #tabs li.disabled a:visited, #tabs li.disabled a:hover,
+      #subtabs li.disabled, #subtabs li.disabled a, #subtabs li.disabled a:visited, #subtabs li.disabled a:hover {
+        color: #{@@css.inactive_text_color};
+      }
+
+      #tabs a {
+        text-decoration: none;
+      }
+
+      #tabs ul {
+        font-size: 24px;
+        height: 57px;
+        list-style-type: none;
+        background-color: #{@@css.background_color};
+        padding: 0 0 0 50px;
+      }
+
+      #tabs ul li {
+        padding-top: 25px;
+        padding-right: 5px;
+        float: left;
+      }
+
+      #tabs ul li .tab {
+        background-color: #{@@css.inactive_tab_color};
+        padding: 5px 15px 3px 15px;
+        float: left;
+      	-webkit-border-top-left-radius: 8px;
+      	-khtml-border-radius-topleft: 8px;	
+      	-moz-border-radius-topleft: 8px;
+      	border-top-left-radius: 8px;
+      	-webkit-border-top-right-radius: 8px;
+      	-khtml-border-radius-topright: 8px;	
+      	-moz-border-radius-topright: 8px;
+      	border-top-right-radius: 8px;
+      }
+
+      #tabs ul li.active .tab {
+        background-color: #{@@css.active_tab_color};
+        padding-bottom: 14px;
+      }
+
+      #tabs ul li a:hover {
+        background-color: #{@@css.hover_tab_color};
+      }
+
+      #tabs ul {
+        /* float clearing */
+        overflow: hidden;
+        display: inline-block; /* Necessary to trigger "hasLayout" in IE */
+        display: block; /* Sets element back to block */
+      }
+
+      #subtabs ul {
+        margin-top: 5px;
+      }
+
+      #subtabs, #subtabs a, #subtabs a:visited {
+        color: #{@@css.text_color};
+      }
+
+      #subtabs li.active {
+        font-weight: bold;
+      }
+
+      #subtabs a {
+        text-decoration: none;
+      }
+
+      #subtabs ul {
+        font-size: 16px;
+        height: 30px;
+        list-style-type: none;
+        padding: 0 0 0 50px;
+      }
+
+      #subtabs ul li {
+        padding: 10px;
+        float: left;
+      }
+
+      #subtabs ul li a:hover {
+        text-decoration: underline;
+      }
+
+      </style>
+    }
+  end
+end