tabulous 1.3.2 → 2.0.0

data/script/create_test_app

@@ -57,9 +57,7 @@ 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 "Generating a new rails app:"
 puts
 
 rails_executable_version = %x{ rails _#{rails_version}_ -v }

data/script/for_all_test_apps

@@ -9,7 +9,6 @@
 #  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
@@ -17,9 +16,7 @@ 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'
+if 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*']

data/spec/applications/README.md

@@ -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.
+
+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.

data/spec/applications/application_template_helper.rb

@@ -2,8 +2,8 @@
 #   Refer to spec/applications/README for a full understanding of test applications.   #
 #**************************************************************************************#
 
-require File.expand_path('../universal_gemfile', __FILE__)
-require File.expand_path('../shims', __FILE__)
+require_relative 'universal_gemfile'
+require_relative 'shims'
 
 # convenience method to save typing
 def replace_view(controller_name, action_name, view_code)

data/spec/applications/bootstrap/application_template.rb

@@ -0,0 +1,77 @@
+require File.expand_path('../../application_template_helper', __FILE__)
+
+generate_test_application do
+
+  #*****************************************************************************
+  #  MODELS AND SCAFFOLDING
+
+  generate(:scaffold, 'galaxy name:string --old-style-hash')
+  generate(:scaffold, 'planet name:string --old-style-hash')
+  generate(:scaffold, 'star name:string --old-style-hash')
+
+  #*****************************************************************************
+  #  MORE CONTROLLERS AND VIEWS
+
+  generate(:controller, 'home index --old-style-hash')
+  replace_view 'home', 'index', <<-CODE.strip_heredoc
+    <h1>Explanation</h1>
+    This tests tabulous integrating with Twitter Bootstrap.
+  CODE
+  generate(:controller, 'no_tabs index --old-style-hash')
+  replace_view 'no_tabs', 'index', <<-CODE.strip_heredoc
+    <h1>Explanation</h1>
+    This tests what happens when you visit a controller action that is not associated
+    with any tab.
+  CODE
+  generate(:controller, 'subtabs one two three --old-style-hash')
+  replace_view 'subtabs', 'one', '<p>Subtab #1</p>'
+  replace_view 'subtabs', 'two', '<p>Subtab #2</p>'
+  replace_view 'subtabs', 'three', '<p>Subtab #3</p>'
+
+  #*****************************************************************************
+  #  MORE ROUTES
+
+  route "root :to => 'home#index'"
+  route "get 'notabs' => 'no_tabs#index'"
+
+  #*****************************************************************************
+  #  LAYOUT
+
+  replace_application_layout <<-CODE.strip_heredoc
+    <!DOCTYPE html>
+    <html>
+    <head>
+      <meta charset="utf-8">
+      <title>Bootstrap</title>
+      <%= csrf_meta_tag %>
+      <%= stylesheet_link_tag 'application' %>
+      <%= javascript_include_tag 'application' %>
+    </head>
+    <body>
+
+      <div class="navbar navbar-inverse navbar-fixed-top">
+        <div class="navbar-inner">
+          <div class="container">
+            <a class="brand" href="#">Tabulous Bootstrap Test App</a>
+            <div class="nav-collapse collapse">
+              <%= tabs %>
+            </div>
+          </div>
+        </div>
+      </div>
+
+      <div id="main_content" class="container">
+        <%= yield %>
+      </div>
+
+    </body>
+    </html>
+  CODE
+
+  #*****************************************************************************
+  #  CSS CLEANUP
+
+  remove_file 'app/assets/stylesheets/application.css'
+  remove_file 'app/assets/stylesheets/scaffolds.css.scss'
+
+end

data/spec/applications/bootstrap/rails_3-2-13/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/applications/bootstrap/rails_3-2-13/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+gem 'tabulous', :path => "../../../.."
+gem 'sqlite3', '>= 1.3.7'
+group :test, :development do
+  gem "rspec-rails"
+end
+group :test do
+  gem 'capybara', "~> 2.0.2"
+  gem 'launchy'
+end
+gem 'rails', '~> 3.2.0'
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'bootstrap-sass', '~> 2.3.1.0'
+  gem 'coffee-rails', '~> 3.2.1'
+  gem 'uglifier', '>= 1.0.3'
+end
+gem 'jquery-rails'
+group :test do
+  gem 'turn', :require => false
+  gem 'minitest'
+end

data/spec/applications/bootstrap/rails_3-2-13/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/applications/bootstrap/rails_3-2-13/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails3213::Application.load_tasks

data/spec/applications/bootstrap/rails_3-2-13/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require bootstrap
+//= require_tree .

data/spec/applications/bootstrap/rails_3-2-13/app/assets/javascripts/galaxies.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/

data/spec/applications/bootstrap/rails_3-2-13/app/assets/javascripts/home.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/

data/spec/applications/bootstrap/rails_3-2-13/app/assets/javascripts/no_tabs.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/

data/spec/applications/bootstrap/rails_3-2-13/app/assets/javascripts/planets.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/

data/spec/applications/bootstrap/rails_3-2-13/app/assets/javascripts/stars.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/

data/spec/applications/bootstrap/rails_3-2-13/app/assets/javascripts/subtabs.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/

data/spec/applications/bootstrap/rails_3-2-13/app/assets/stylesheets/application.scss

@@ -0,0 +1,19 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */
+
+@import "bootstrap";
+
+#main_content {
+  margin: 60px;
+}

data/spec/applications/bootstrap/rails_3-2-13/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end