tabulous 1.3.1 → 1.3.2

data/.gitignore

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

data/CHANGELOG.rdoc

@@ -0,0 +1,40 @@
+== 1.3.2 (April 12, 2013)
+* Fixed a bug where the gem's gemspec did not include all of the files.
+
+== 1.3.1 (April 6, 2013)
+* Ensured compatibility with Rails 4.0.0.beta1 and Ruby 2.0.
+* Maintained compatibility with Rails 3.0, 3.1 and 3.2 and Ruby 1.8 and 1.9.
+* Complete overhaul of the test applications to make them easier to test across multiple versions of
+  Rails and Ruby.
+
+== 1.3.0 (March 20, 2012)
+* Added config.subtabs_ul_class.
+* Verified that tabulous works with Ruby 1.9.3.
+
+== 1.2.0 (February 8, 2012)
+* Added support for Twitter Bootstrap (version 2).
+* Noted in the documentation that tabulous works with Rails 3.2.
+
+== 1.1.0 (January 10, 2012)
+* Deprecated the raise_error_if_no_tab_found configuration setting.  Replaced it with
+  config.when_action_has_no_tab.
+* Changed some gem versions in the development dependencies.
+
+== 1.0.3 (November 6, 2011)
+* Added support for Rails 3.1 (finally!).
+
+== 1.0.2 (April 19, 2011)
+* Fixed bug where the tabs generator would crash if there were index routes that were not named.
+
+== 1.0.1 (March 9, 2011)
+* No longer requires Rubygems version > 1.4.0; requires > 1.3.7 instead.
+
+== 1.0.0 (March 4, 2011)
+* Moved tab file from config/initializers/tabulous.rb to app/tabs/tabulous.rb.
+* Changed syntax so that config.tabs and config.actions accepts a block.
+
+== 0.0.2 (March 2, 2011)
+* Changed homepage in gemspec.
+
+== 0.0.1 (March 2, 2011)
+* Initial release.

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright 2011-2013 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,81 @@
+= Tabulous
+
+== Description
+
+Tabulous provides an easy way to add tabs to your Rails application.
+
+== Requirements
+
+Tabulous works with Rails 3.0, 3.1, 3.2 and 4.0.  It has been tested on Ruby 1.8.7, 1.9.3 and 2.0.0.
+
+== 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 file:
+
+  rails generate tabs
+
+This will generate app/tabs/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
+
+There is a tutorial at http://techiferous.com/2011/03/tutorial-for-adding-tabs-to-rails-using-tabulous/
+
+== Twitter Bootstrap
+
+To get tabulous to work with Twitter Bootstrap version 2, make sure the
+following values are set in app/tabs/tabulous.rb:
+
+* config.css.scaffolding = false
+* config.tabs_ul_class = "nav nav-pills" # or whatever Bootstrap class you want
+* config.bootstrap_style_subtabs = true
+* config.active_tab_clickable = true
+
+When config.bootstrap_style_subtabs is set to true, the subtabs are rendered
+inside the tab markup, so you only need to call the tabs helper in your
+layout, not the subtabs helper.
+
+Also note that if you use Twitter Bootstrap, you lose the ability to disable
+individual subtabs.

data/Rakefile

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'colored'
+require 'rake'
+require 'rdoc/task'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  desc "Run the unit specs"
+  RSpec::Core::RakeTask.new(:units) do |t|
+    t.pattern = "./spec/lib/**/*_spec.rb"
+  end
+end
+
+task :test do
+  puts
+  puts "To run integration specs:"
+  puts "  $ script/for_all_test_apps rake"
+  puts
+  puts "To run integration specs in a Ruby 1.8 environment:"
+  puts "  $ RUBY_COMPATIBILITY=1.8 script/for_all_test_apps rake"
+  puts
+  puts "To run integration specs in a Ruby 2.0 environment:"
+  puts "  $ RUBY_COMPATIBILITY=2.0 script/for_all_test_apps rake"
+  puts
+  puts "To run unit specs:"
+  puts "  $ rake spec:units"
+  puts
+  puts "You may need to run this first before the integration specs will pass:"
+  puts "  $ script/for_all_test_apps bundle install"
+  puts
+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/tabulous/version.rb

@@ -1,3 +1,3 @@
 module Tabulous
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/lib/tasks/tabulous.rake

@@ -0,0 +1,11 @@
+namespace :tabs do
+  desc "Prettify app/tabs/tabulous.rb"
+  task :format do
+    require File.expand_path('../tabulous/formatter', File.dirname(__FILE__))
+    filename = File.join(Rails.root.to_s, 'app', 'tabs', 'tabulous.rb')
+    reformatted = Tabulous::Formatter.format(IO.readlines(filename))
+    File.open(filename, 'w') do |f|
+      f.puts reformatted
+    end
+  end
+end

data/script/create_test_app

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+
+# This script is used to generate test applications for testing with various
+# versions of Rails.
+#
+# Refer to spec/applications/README for a full understanding of test
+# applications.
+
+
+require 'fileutils'
+require 'rake' # in order to get the nice sh method, which allows system
+               # command output to be streamed in real time
+include FileUtils
+
+#*******************************************************************************
+#  CHECK ARGUMENTS
+
+if ARGV.size != 2
+  puts "Usage: create_test_app [app name] [Rails version]"
+  puts "  both arguments are required"
+  puts "  app name: the name of an application living in spec/applications"
+  puts "  Rails version: the gem version, such as 3.1.11 or 4.0.0.beta"
+  puts
+  puts "  Read spec/applications/README for a full understanding of test apps."
+  exit
+end
+
+app_name = ARGV[0]
+rails_version = ARGV[1]
+
+installed_rails_versions = %x{ gem list rails }
+if installed_rails_versions =~ /rails\s\((.+)\)/
+  versions = $1.split(',').map(&:strip)
+  if !versions.include?(rails_version)
+    abort "Rails version '#{rails_version}' is not installed. First install this version of Rails before continuing."
+  end
+else
+  abort "Rails is not installed. First install the version of Rails you wish to use."
+end
+
+test_app_dir = File.expand_path('../../spec/applications', __FILE__)
+test_app_dirs = Dir[test_app_dir+'/*'].select{|f| File.directory?(f)}
+test_app_names = test_app_dirs.map{|x| x.split('/').last}.select{|f| f != 'universal'}
+if !test_app_names.include?(app_name)
+  abort "Could not find test app named '#{app_name}' in spec/applications. Read spec/applications/README for a full understanding of test apps."
+end
+
+#*******************************************************************************
+#  INVOKE RAILS TEMPLATE
+
+app_dir = File.expand_path("../../spec/applications/#{app_name}/" + 'rails_' + rails_version.gsub('.', '-'), __FILE__)
+if File.exists?(app_dir)
+  FileUtils.remove_dir(app_dir, true)
+end
+
+app_template_path = File.expand_path("../../spec/applications/#{app_name}/application_template.rb", __FILE__)
+
+app_generation_command = "TEST_APP_RAILS_VERSION='#{rails_version}' rails _#{rails_version}_ new #{app_dir} -m #{app_template_path} --old-style-hash"
+puts "Generating a new rails app with the command:"
+puts
+puts app_generation_command
+puts
+
+rails_executable_version = %x{ rails _#{rails_version}_ -v }
+if rails_executable_version !~ %r{#{rails_version}}
+  puts "Accessing the executable for rails version #{rails_version} failed."
+  puts "  The rails gem with version #{rails_version} appears to be installed."
+  puts "  However, running 'rails _#{rails_version}_ -v' did not produce the right version of Rails."
+  puts
+  puts "  Refer to spec/applications/README for a better understanding of this issue."
+  abort
+end
+
+sh "#{app_generation_command}"

data/script/for_all_test_apps

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+# Run a command for all test apps.  Examples:
+#
+#  $ script/for_all_test_apps bundle install
+#  $ script/for_all_test_apps bundle exec rake db:migrate
+#  $ script/for_all_test_apps bundle exec rake test
+#
+#  Set the RUBY_COMPATIBILITY environment variable to limit the action to
+#  only those test apps that are compatible with that version of Ruby.
+
+require 'rubygems' # for Ruby 1.8.7
+require 'colored'
+require 'rake' # in order to get the nice sh method, which allows system
+               # command output to be streamed in real time
+include FileUtils
+
+command = ARGV.join(' ')
+
+if ENV['RUBY_COMPATIBILITY'] == '1.8'
+  apps_to_test = Dir['spec/applications/*/rails_3*']
+elsif ENV['RUBY_COMPATIBILITY'] == '2.0'
+  apps_to_test = Dir['spec/applications/*/rails_3-2*'] + Dir['spec/applications/*/rails_4*']
+else
+  apps_to_test = Dir['spec/applications/*/rails*']
+end
+
+apps_to_test.each do |filename|
+  if File.directory?(filename)
+    name = filename.split('/')[-2..-1].join('/')
+    print "Running".magenta
+    print " #{command} ".yellow
+    print "in test app".magenta
+    print " #{name} ".yellow
+    puts
+    sh "cd #{filename} && #{command}"
+  end
+end

data/spec/applications/README

@@ -0,0 +1,109 @@
+# Test Applications
+
+
+
+## What's the point?
+
+Since the behavior of tabulous affects the application as a whole, to really
+test it well we need to use integration tests.
+
+We also need to have several different test applications in order to test
+various configurations, such as using it with Twitter Bootstrap, using it with
+or without subtabs, etc.
+
+And finally, we care that tabulous works well in multiple versions of Rails.
+
+So if we had four test applications and were testing against three versions of
+Rails, all of a sudden we've got twelve different applications and their
+accompanying tests to manage.  Ouch!
+
+So the whole point of this setup is to take away the pain of testing multiple
+test applications against multiple versions of Rails.
+
+
+
+## Okay, so how does this work?
+
+We use Rails application templates to generate our test apps.  This means that
+we don't want to make changes to any Rails test app directly, because those
+changes will get lost when the app is re-generated.
+
+Each kind of test application lives under its own directory in spec/applications
+(e.g., spec/applications/main).
+
+The Rails application template lives in this directory and should be called
+application_template.rb.  This gives instructions for how to generate the test
+app.
+
+When we generate a new test application and specify a Rails version, the test
+application will end up in spec/applications/[app_name]/[rails-version].
+
+When the application in generated, it uses the gems described in
+spec/applications/universal_gemfile.rb.
+
+Any files and directories in spec/applications/universal will be copied over to
+the new Rails app.  This is where we would put any tests that we would want to
+run in every one of our test applications, for example.
+
+Any files and directories in spec/applications/[app_name]/shared will be copied
+over to the new Rails app.  This is where we would put all of the tests that we
+would want run for this kind of test app.
+
+
+
+## So how do we generate a test app?
+
+Let's say Rails 17.0.4 is released and we want to test the "main" test app
+against this.  Run this script:
+
+$ script/create_test_app main 17.0.4
+
+This will create a Rails app in spec/applications/main/rails_17-0-4.  When it is
+finished generating, we can go into the new Rails app's directory and run tests
+like so:
+
+$ bundle exec rake test
+$ bundle exec rake spec
+$ bundle exec rake
+
+
+
+## So how do we set up a new kind of test application?
+
+* Create a new directory under spec/applications.
+* Create a new application_template.rb file in this directory.  Follow the
+  pattern of the other test app's application templates.
+* Create a shared directory in this directory.  Any files put here will be
+  copied when we generate a new Rails app based on the application template.
+* Any specs or tests should live in this shared directory.
+* If we need to add any gems to the Rails app, modify
+  spec/applications/universal_gemfile.rb.
+
+
+
+## WTF?! Why isn't this working for me?
+
+Two things can be particularly problematic when testing multiple versions of
+Rails apps from within a gem:
+
+### Wrong Gemfile
+
+Bundler can get confused and accidentally use the tabulous gem's Gemfile
+instead of the Gemfile found in the test app.  So if you have gem version
+problems, consider this.  More info is here: http://spectator.in/2011/01/28/bundler-in-subshells/
+
+### Wrong Rails Executable
+
+When you have multiple versions of Rails installed, it can be very difficult
+to target the correct version of the rails executable to use.  Even if you
+use the rails _version.number_ trick, the wrong version of Rails may still
+be used.  This is because rails is a dependency in tabulous's Gemfile, and so
+even if you try to force the usage of a different rails executable, the version
+specified in the Gemfile may be winning.  This probably depends on what tools
+you are using to manage your gems and rubies (rvm, Bundler, rubygems-bundler,
+etc.).
+
+If you have this problem, one way to get the generation of a new test application
+to work is to create a fresh, new gemset and install just that version of
+Rails in it.  Then you can create a new test application targeted to that
+version of Rails.