rails 0.8.5 → 0.9.0

data/CHANGELOG

@@ -1,3 +1,89 @@
+*CVS*
+
+* Renamed public/dispatch.servlet to script/server -- it wasn't really dispatching anyway as its delegating calls to public/dispatch.rb
+
+* Renamed AbstractApplicationController and abstract_application.rb to ApplicationController and application.rb, so that it will be possible
+  for the framework to automatically pick up on app/views/layouts/application.rhtml and app/helpers/application.rb
+
+* Added script/console that makes it even easier to start an IRB session for interacting with the domain model. Run with no-args to
+  see help.
+
+* Added breakpoint support through the script/breakpointer client. This means that you can break out of execution at any point in
+  the code, investigate and change the model, AND then resume execution! Example:
+  
+    class WeblogController < ActionController::Base
+      def index
+        @posts = Post.find_all
+        breakpoint "Breaking out from the list"
+      end
+    end
+    
+  So the controller will accept the action, run the first line, then present you with a IRB prompt in the breakpointer window. 
+  Here you can do things like:
+  
+  Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
+
+    >> @posts.inspect
+    => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>, 
+         #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+    >> @posts.first.title = "hello from a breakpoint"
+    => "hello from a breakpoint"
+
+  ...and even better is that 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 press CTRL-D
+
+* Changed environments to be configurable through an environment variable. By default, the environment is "development", but you
+  can change that and set your own by configuring the Apache vhost with a string like (mod_env must be available on the server):
+  
+    SetEnv RAILS_ENV production
+  
+  ...if you're using WEBrick, you can pick the environment to use with the command-line parameters -e/--environment, like this:
+  
+    ruby public/dispatcher.servlet -e production
+
+* Added a new default environment called "development", which leaves the production environment to be tuned exclusively for that.
+
+* Added a start_server in the root of the Rails application to make it even easier to get started
+
+* Fixed public/.htaccess to use RewriteBase and share the same rewrite rules for all the dispatch methods
+
+* Fixed webrick_server to handle requests in a serialized manner (the Rails reloading infrastructure is not thread-safe)
+
+* Added support for controllers in directories. So you can have:
+
+    app/controllers/account_controller.rb        # URL: /account/
+    app/controllers/admin/account_controller.rb  # URL: /admin/account/
+  
+  NOTE: You need to update your public/.htaccess with the new rules to pick it up
+
+* Added reloading for associations and dependencies under cached environments like FastCGI and mod_ruby. This makes it possible to use 
+  those environments for development. This is turned on by default, but can be turned off with 
+  ActiveRecord::Base.reload_associations = false and ActionController::Base.reload_dependencies = false in production environments.
+
+* Added support for sub-directories in app/models. So now you can have something like Basecamp with:
+
+    app/models/accounting
+    app/models/project
+    app/models/participants
+    app/models/settings
+  
+  It's poor man's namespacing, but only for file-system organization. You still require files just like before.
+  Nothing changes inside the files themselves.
+
+
+* Fixed a few references in the tests generated by new_mailer [bitsweat]
+
+* Added support for mocks in testing with test/mocks
+
+* Cleaned up the environments a bit and added global constant RAILS_ROOT
+
+
 *0.8.5* (9)
 
 * Made dev-util available to all tests, so you can insert breakpoints in any test case to get an IRB prompt at that point [bitsweat]:

data/README

@@ -34,23 +34,21 @@ link:files/vendor/actionpack/README.html.
 
 * Apache 1.3.x or 2.x (or any FastCGI-capable webserver with a
   mod_rewrite-like module)
-* FastCGI (or mod_ruby) for production performance (CGI is used for
-  development)
+* FastCGI (or mod_ruby) for better performance on Apache
 
 == Getting started
 
-1a. Setup Apache for the Rails application (see "Example for Apache conf")
-1b. Run the WEBrick servlet: <tt>ruby public/dispatch.servlet --help</tt>
-2. Go to http://rails/ (or whatever is your ServerName) and check
-   that you get the "Congratulations, you're on Rails!" screen
-3. Follow the guidelines on the "Congratulations, you're on Rails!" screen
+1. Run the WEBrick servlet: <tt>ruby script/server</tt>
+   (run with --help for options)
+2. Go to http://localhost:3000/ and get "Congratulations, you've put Ruby on Rails!"
+3. Follow the guidelines on the "Congratulations, you've put Ruby on Rails!" screen
 
 
 == Example for Apache conf
 
   <VirtualHost *:80>
     ServerName rails
-    DocumentRoot /path/tapplication/public/
+    DocumentRoot /path/application/public/
     ErrorLog /path/application/log/apache.log
   
     <Directory /path/application/public/>
@@ -75,6 +73,48 @@ information to these files. Debugging info will also be shown in the browser
 on requests from 127.0.0.1.
 
 
+== Breakpoints
+
+Breakpoint support is available through the script/breakpointer client. This
+means that you can break out of execution at any point in the code, investigate
+and change the model, AND then resume execution! Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find_all
+      breakpoint "Breaking out from the list"
+    end
+  end
+  
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the breakpointer window. Here you can do things like:
+
+Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>, 
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a breakpoint"
+  => "hello from a breakpoint"
+
+...and even better is that 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 press CTRL-D
+
+
+== Console
+
+You can interact with the domain model by starting the console through script/console. 
+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. Start the script without arguments to see the options.
+
+
 == Description of contents
 
 app

data/Rakefile

@@ -9,21 +9,35 @@ require 'date'
 
 PKG_BUILD       = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
 PKG_NAME        = 'rails'
-PKG_VERSION     = '0.8.5' + PKG_BUILD
+PKG_VERSION     = '0.9.0' + PKG_BUILD
 PKG_FILE_NAME   = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_DESTINATION = ENV["RAILS_PKG_DESTINATION"] || "../#{PKG_NAME}"
 
+
+BASE_DIRS   = %w( app config/environments db doc log lib public script test vendor )
+APP_DIRS    = %w( models controllers helpers views views/layouts )
+PUBLIC_DIRS = %w( images javascripts stylesheets _doc )
+TEST_DIRS   = %w( fixtures unit functional mocks mocks/development mocks/testing )
+
+LOG_FILES    = %w( apache.log development.log test.log production.log )
+HTML_FILES   = %w( 404.html 500.html index.html )
+BIN_FILES    = %w( generate breakpointer console server )
+GENERATORS   = %w( controller mailer model scaffold )
+
+VENDOR_LIBS = %w( actionpack activerecord actionmailer railties )
+
+
 desc "Default Task"
 task :default => [ :fresh_rails ]
 
 desc "Generates a fresh Rails package with documentation"
-task :fresh_rails => [ :make_dir_structure, :initialize_file_stubs, :copy_vendor_libraries, :copy_ties_content, :generate_documentation ]
+task :fresh_rails => [ :clean, :make_dir_structure, :initialize_file_stubs, :copy_vendor_libraries, :copy_ties_content, :generate_documentation ]
 
 desc "Generates a fresh Rails package using GEMs with documentation"
-task :fresh_gem_rails => [ :make_dir_structure, :initialize_file_stubs, :copy_ties_content, :copy_gem_environment ]
+task :fresh_gem_rails => [ :clean, :make_dir_structure, :initialize_file_stubs, :copy_ties_content, :copy_gem_environment ]
 
 desc "Generates a fresh Rails package without documentation (faster)"
-task :fresh_rails_without_docs => [ :make_dir_structure, :initialize_file_stubs, :copy_vendor_libraries, :copy_ties_content ]
+task :fresh_rails_without_docs => [ :clean, :make_dir_structure, :initialize_file_stubs, :copy_vendor_libraries, :copy_ties_content ]
 
 desc "Packages the fresh Rails package with documentation"
 task :package => [ :clean, :fresh_rails ] do
@@ -32,90 +46,47 @@ task :package => [ :clean, :fresh_rails ] do
 end
 
 task :clean do
-  File.rm_rf "#{PKG_DESTINATION}"
+  rm_rf PKG_DESTINATION
 end
 
 
 # Make directory structure ----------------------------------------------------------------
 
-desc "Make the directory structure for the new Rails application"
-task :make_dir_structure => [ :make_base_dirs, :make_app_dirs, :make_public_dirs, :make_test_dirs ] do
-end
-
-task :make_base_dirs do
-  File.rm_rf PKG_DESTINATION
-  File.mkdir "#{PKG_DESTINATION}"
-  File.mkdir "#{PKG_DESTINATION}/app"
-  File.mkdir "#{PKG_DESTINATION}/config"
-  File.mkdir "#{PKG_DESTINATION}/config/environments"
-  File.mkdir "#{PKG_DESTINATION}/db"
-  File.mkdir "#{PKG_DESTINATION}/doc"
-  File.mkdir "#{PKG_DESTINATION}/log"
-  File.mkdir "#{PKG_DESTINATION}/lib"
-  File.mkdir "#{PKG_DESTINATION}/public"
-  File.mkdir "#{PKG_DESTINATION}/script"
-  File.mkdir "#{PKG_DESTINATION}/test"
-  File.mkdir "#{PKG_DESTINATION}/vendor"
+def make_dest_dirs(dirs, path = nil)
+  mkdir_p dirs.map { |dir| File.join(PKG_DESTINATION, path, dir) }
 end
 
-task :make_app_dirs do
-  File.mkdir "#{PKG_DESTINATION}/app/models"
-  File.mkdir "#{PKG_DESTINATION}/app/controllers"
-  File.mkdir "#{PKG_DESTINATION}/app/helpers"
-  File.mkdir "#{PKG_DESTINATION}/app/views"
-  File.mkdir "#{PKG_DESTINATION}/app/views/layouts"
-end
-
-task :make_public_dirs do
-  File.mkdir "#{PKG_DESTINATION}/public/images"
-  File.mkdir "#{PKG_DESTINATION}/public/javascripts"
-  File.mkdir "#{PKG_DESTINATION}/public/stylesheets"
-  File.mkdir "#{PKG_DESTINATION}/public/_doc"
-end
+desc "Make the directory structure for the new Rails application"
+task :make_dir_structure => [ :make_base_dirs, :make_app_dirs, :make_public_dirs, :make_test_dirs ]
 
-task :make_test_dirs do
-  File.mkdir "#{PKG_DESTINATION}/test/fixtures"
-  File.mkdir "#{PKG_DESTINATION}/test/unit"
-  File.mkdir "#{PKG_DESTINATION}/test/functional"
-end
+task(:make_base_dirs)   { make_dest_dirs BASE_DIRS              }
+task(:make_app_dirs)    { make_dest_dirs APP_DIRS,    'app'     }
+task(:make_public_dirs) { make_dest_dirs PUBLIC_DIRS, 'public'  }
+task(:make_test_dirs)   { make_dest_dirs TEST_DIRS,   'test'    }
 
 
 # Initialize file stubs -------------------------------------------------------------------
 
 desc "Initialize empty file stubs (such as for logging)"
-task :initialize_file_stubs => [ :initialize_log_files ] do
-end
+task :initialize_file_stubs => [ :initialize_log_files ]
 
 task :initialize_log_files do
-  chmod 0777, "#{PKG_DESTINATION}/log"
-
-  File.touch "#{PKG_DESTINATION}/log/apache.log"
-  File.touch "#{PKG_DESTINATION}/log/production.log"
-
-  chmod 0777, "#{PKG_DESTINATION}/log/apache.log"
-  chmod 0777, "#{PKG_DESTINATION}/log/production.log"
+  log_dir = File.join(PKG_DESTINATION, 'log')
+  chmod 0777, log_dir
+  LOG_FILES.each do |log_file|
+    log_path = File.join(log_dir, log_file)
+    touch log_path
+    chmod 0777, log_path
+  end
 end
 
 
 # Copy Vendors ----------------------------------------------------------------------------
 
 desc "Copy in all the Rails packages to vendor"
-task :copy_vendor_libraries => [ :copy_action_pack, :copy_active_record, :copy_ties, :copy_action_mailer ]
-
-task :copy_action_pack do
-  File.cp_r "../actionpack", "#{PKG_DESTINATION}/vendor/actionpack"
-end
-
-task :copy_active_record do
-  File.cp_r "../activerecord", "#{PKG_DESTINATION}/vendor/activerecord" 
-end
-
-task :copy_action_mailer do
-  File.cp_r "../actionmailer", "#{PKG_DESTINATION}/vendor/actionmailer" 
-end
-
-task :copy_ties do
-  File.cp_r "../railties", "#{PKG_DESTINATION}/vendor/railties" 
+task :copy_vendor_libraries do
+  cp_r VENDOR_LIBS.map { |dir| File.join('..', dir) },
+       File.join(PKG_DESTINATION, 'vendor')
 end
 
 
@@ -124,85 +95,89 @@ end
 # :link_apache_config
 desc "Make copies of all the default content of ties"
 task :copy_ties_content => [ 
-  :copy_rootfiles, :copy_dispatches, :copy_html_files, :copy_abstract_application,
-  :copy_configs, :copy_generators, :copy_test_helpers, :copy_docs_in_public,
-  :copy_app_doc_readme ] do
-end
+  :copy_rootfiles, :copy_dispatches, :copy_html_files, :copy_application,
+  :copy_configs, :copy_binfiles, :copy_test_helpers, :copy_docs_in_public,
+  :copy_app_doc_readme ]
 
 task :copy_dispatches do
-  File.cp "dispatches/dispatch.rb", "#{PKG_DESTINATION}/public/dispatch.rb"
+  cp "dispatches/dispatch.rb", "#{PKG_DESTINATION}/public/dispatch.rb"
   chmod 0755, "#{PKG_DESTINATION}/public/dispatch.rb"
 
-  File.cp "dispatches/dispatch.rb", "#{PKG_DESTINATION}/public/dispatch.cgi"
+  cp "dispatches/dispatch.rb", "#{PKG_DESTINATION}/public/dispatch.cgi"
   chmod 0755, "#{PKG_DESTINATION}/public/dispatch.cgi"
 
-  File.cp "dispatches/dispatch.fcgi", "#{PKG_DESTINATION}/public/dispatch.fcgi"
+  cp "dispatches/dispatch.fcgi", "#{PKG_DESTINATION}/public/dispatch.fcgi"
   chmod 0755, "#{PKG_DESTINATION}/public/dispatch.fcgi"
 
-  File.cp "dispatches/dispatch.servlet", "#{PKG_DESTINATION}/public/dispatch.servlet"
+  cp "bin/console", "#{PKG_DESTINATION}/script/console"
+  chmod 0755, "#{PKG_DESTINATION}/script/console"
 end
 
 task :copy_html_files do
-  File.cp "html/404.html", "#{PKG_DESTINATION}/public/404.html"
-  File.cp "html/500.html", "#{PKG_DESTINATION}/public/500.html"
-  File.cp "html/index.html", "#{PKG_DESTINATION}/public/index.html"
+  cp HTML_FILES.map { |dir| File.join('html', dir) },
+     File.join(PKG_DESTINATION, 'public')
 end
 
-task :copy_abstract_application do
-  File.cp "helpers/abstract_application.rb", "#{PKG_DESTINATION}/app/controllers/abstract_application.rb"
-  File.cp "helpers/application_helper.rb", "#{PKG_DESTINATION}/app/helpers/application_helper.rb"
+task :copy_application do
+  cp "helpers/application.rb", "#{PKG_DESTINATION}/app/controllers/application.rb"
+  cp "helpers/application_helper.rb", "#{PKG_DESTINATION}/app/helpers/application_helper.rb"
 end
 
 task :copy_configs do
-  File.cp "configs/database.yml", "#{PKG_DESTINATION}/config/database.yml"
+  cp "configs/database.yml", "#{PKG_DESTINATION}/config/database.yml"
 
-  File.cp "configs/apache.conf", "#{PKG_DESTINATION}/public/.htaccess"
+  cp "configs/apache.conf", "#{PKG_DESTINATION}/public/.htaccess"
 
-  File.cp "environments/shared.rb", "#{PKG_DESTINATION}/config/environments/shared.rb"
-  File.cp "environments/production.rb", "#{PKG_DESTINATION}/config/environments/production.rb"
-  File.cp "environments/test.rb", "#{PKG_DESTINATION}/config/environments/test.rb"
+  cp "environments/shared.rb", "#{PKG_DESTINATION}/config/environment.rb"
+  cp "environments/production.rb", "#{PKG_DESTINATION}/config/environments/production.rb"
+  cp "environments/development.rb", "#{PKG_DESTINATION}/config/environments/development.rb"
+  cp "environments/test.rb", "#{PKG_DESTINATION}/config/environments/test.rb"
 end
 
 task :copy_generators do
-  File.cp "generators/new_controller.rb", "#{PKG_DESTINATION}/script/new_controller"
-  File.cp "generators/new_model.rb", "#{PKG_DESTINATION}/script/new_model"
-  File.cp "generators/new_mailer.rb", "#{PKG_DESTINATION}/script/new_mailer"
-  File.cp "generators/new_crud.rb", "#{PKG_DESTINATION}/script/new_crud"
-  chmod 0755, "#{PKG_DESTINATION}/script/new_controller"
-  chmod 0755, "#{PKG_DESTINATION}/script/new_model"
-  chmod 0755, "#{PKG_DESTINATION}/script/new_mailer"
-  chmod 0755, "#{PKG_DESTINATION}/script/new_crud"
+  mkdir_p File.join(PKG_DESTINATION, 'script/generators')
+
+  GENERATORS.each do |dir|
+    cp_r File.join('generators', dir), File.join(PKG_DESTINATION, 'script', 'generators', dir)
+  end
+end
+
+task :copy_binfiles do
+  BIN_FILES.each do |file|
+    dest_file = File.join(PKG_DESTINATION, 'script', file)
+    cp File.join('bin', file), dest_file
+    chmod 0755, dest_file
+  end
 end
 
 task :copy_rootfiles do
-  File.cp "fresh_rakefile", "#{PKG_DESTINATION}/Rakefile"
-  File.cp "README", "#{PKG_DESTINATION}/README"
+  cp "fresh_rakefile", "#{PKG_DESTINATION}/Rakefile"
+  cp "README", "#{PKG_DESTINATION}/README"
 end
 
 task :copy_test_helpers do
-  File.cp "helpers/test_helper.rb", "#{PKG_DESTINATION}/test/test_helper.rb"
+  cp "helpers/test_helper.rb", "#{PKG_DESTINATION}/test/test_helper.rb"
 end
 
 task :copy_docs_in_public do
-  File.cp "doc/index.html", "#{PKG_DESTINATION}/public/_doc/index.html"
+  cp "doc/index.html", "#{PKG_DESTINATION}/public/_doc/index.html"
 end
 
 task :copy_app_doc_readme do
-  File.cp "doc/README_FOR_APP", "#{PKG_DESTINATION}/doc/README_FOR_APP"
+  cp "doc/README_FOR_APP", "#{PKG_DESTINATION}/doc/README_FOR_APP"
 end
 
 task :link_apache_config do
-  cd "#{PKG_DESTINATION}/config/"
-  ln_s "../public/.htaccess", "apache.conf"
-  cd "../../railties"
+  chdir(File.join(PKG_DESTINATION, 'config')) {
+    ln_s "../public/.htaccess", "apache.conf"
+  }
 end
 
 
 # Generate documentation ------------------------------------------------------------------
 
 desc "Generate documentation for the framework and for the empty application"
-task :generate_documentation => [ :generate_app_doc, :generate_rails_framework_doc ] do
-end
+task :generate_documentation => [ :generate_app_doc, :generate_rails_framework_doc ]
 
 task :generate_rails_framework_doc do
   system %{cd #{PKG_DESTINATION}; rake apidoc}
@@ -217,7 +192,8 @@ end
 # Generate GEM ----------------------------------------------------------------------------
 
 task :copy_gem_environment do
-  File.cp "environments/shared_for_gem.rb", "#{PKG_DESTINATION}/config/environments/shared.rb"
+  cp "environments/shared_for_gem.rb", "#{PKG_DESTINATION}/config/environment.rb"
+  cp "bin/breakpointer_for_gem", "#{PKG_DESTINATION}/script/breakpointer"
 end
 
 
@@ -228,8 +204,8 @@ PKG_FILES = FileList[
   'doc/**/*', 
   'dispatches/**/*', 
   'environments/**/*', 
-  'generators/**/*', 
   'helpers/**/*', 
+  'generators/**/*', 
   'html/**/*', 
   'lib/**/*'
 ]
@@ -248,7 +224,9 @@ spec = Gem::Specification.new do |s|
   s.add_dependency('actionpack', '>= 0.9.5')
   s.add_dependency('actionmailer', '>= 0.4.0')
 
-  s.files = PKG_FILES.to_a
+  s.has_rdoc = false
+
+  s.files = PKG_FILES.to_a.delete_if {|f| f.include?('.svn')}
   s.require_path = 'lib'
 
   s.bindir = "bin"                               # Use these for applications.
@@ -268,4 +246,5 @@ end
 desc "Publish the API documentation"
 task :pgem => [:gem] do 
   Rake::SshFilePublisher.new("davidhh@one.textdrive.com", "domains/rubyonrails.org/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
-end
+  `ssh davidhh@one.textdrive.com './gemupdate.sh'`
+end