From bc011df210e9cb56e1c4f2cc61dce002861201ef Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Sat, 3 Sep 2005 15:13:06 +0000 Subject: Moved all the shared tasks from Rakefile into Rails, so that the Rakefile is empty and doesn't require updating. Added Rails::Initializer and Rails::Configuration to abstract all of the common setup out of config/environment.rb (uses config/boot.rb to bootstrap the initializer and paths) git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@2115 5ecf4fe2-1ee6-0310-87b1-e25e094e27de --- railties/lib/initializer.rb | 158 +++++++++++++++++++++ .../generators/applications/app/app_generator.rb | 1 + railties/lib/tasks/databases.rake | 93 ++++++++++++ railties/lib/tasks/documentation.rake | 44 ++++++ railties/lib/tasks/misc.rake | 15 ++ railties/lib/tasks/rails.rb | 7 + railties/lib/tasks/statistics.rake | 13 ++ railties/lib/tasks/testing.rake | 40 ++++++ 8 files changed, 371 insertions(+) create mode 100644 railties/lib/initializer.rb create mode 100644 railties/lib/tasks/databases.rake create mode 100644 railties/lib/tasks/documentation.rake create mode 100644 railties/lib/tasks/misc.rake create mode 100644 railties/lib/tasks/rails.rb create mode 100644 railties/lib/tasks/statistics.rake create mode 100644 railties/lib/tasks/testing.rake (limited to 'railties/lib') diff --git a/railties/lib/initializer.rb b/railties/lib/initializer.rb new file mode 100644 index 0000000000..2a172cc53d --- /dev/null +++ b/railties/lib/initializer.rb @@ -0,0 +1,158 @@ +require 'logger' + +RAILS_ENV = ENV['RAILS_ENV'] || 'development' + +module Rails + class Initializer + attr_reader :configuration + + def self.run(command = :process, configuration = Configuration.new) + yield configuration if block_given? + new(configuration).send(command) + end + + def initialize(configuration) + @configuration = configuration + end + + def process + set_load_path + + require_frameworks + require_environment + + initialize_database + initialize_logger + initialize_framework_logging + initialize_routing + end + + def set_load_path + configuration.load_paths.reverse.each { |dir| $LOAD_PATH.unshift(dir) if File.directory?(dir) } + $LOAD_PATH.uniq! + end + + def require_frameworks + configuration.frameworks.each { |framework| require(framework.to_s) } + end + + def require_environment + require_dependency(configuration.environment_file) + end + + def initialize_database + return unless configuration.frameworks.include?(:active_record) + ActiveRecord::Base.configurations = configuration.database_configuration + ActiveRecord::Base.establish_connection + end + + def initialize_logger + begin + logger = Logger.new(configuration.log_path) + logger.level = configuration.log_level + rescue StandardError + logger = Logger.new(STDERR) + logger.level = Logger::WARN + logger.warn( + "Rails Error: Unable to access log file. Please ensure that #{configuration.log_path} exists and is chmod 0666. " + + "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed." + ) + end + + Object.const_set "RAILS_DEFAULT_LOGGER", logger + end + + def initialize_framework_logging + [ActiveRecord, ActionController, ActionMailer].each { |mod| mod::Base.logger ||= RAILS_DEFAULT_LOGGER } + end + + def initialize_framework_views + [ActionController, ActionMailer].each { |mod| mod::Base.template_root ||= configuration.view_path } + end + + def initialize_routing + return unless configuration.frameworks.include?(:action_controller) + ActionController::Routing::Routes.reload + Object.const_set "Controllers", Dependencies::LoadingModule.root(*configuration.controller_paths) + end + end + + class Configuration + attr_accessor :frameworks, :load_paths, :log_level, :log_path, :database_configuration_file, :view_path, :controller_paths + + def initialize + self.frameworks = default_frameworks + self.load_paths = default_load_paths + self.log_path = default_log_path + self.log_level = default_log_level + self.view_path = default_view_path + self.controller_paths = default_controller_paths + self.database_configuration_file = default_database_configuration_file + end + + def database_configuration + YAML::load(ERB.new((IO.read(database_configuration_file))).result) + end + + def environment_file + "environments/#{environment}" + end + + def environment + ::RAILS_ENV + end + + private + def default_frameworks + [ :active_support, :active_record, :action_controller, :action_mailer, :action_web_service ] + end + + def default_load_paths + paths = ["#{environment}/test/mocks/#{environment}"] + + # Then model subdirectories. + paths.concat(Dir["#{RAILS_ROOT}/app/models/[_a-z]*"]) + paths.concat(Dir["#{RAILS_ROOT}/components/[_a-z]*"]) + + # Followed by the standard includes. + paths.concat %w( + app + app/models + app/controllers + app/helpers + app/apis + components + config + lib + vendor + vendor/rails/railties + vendor/rails/railties/lib + vendor/rails/actionpack/lib + vendor/rails/activesupport/lib + vendor/rails/activerecord/lib + vendor/rails/actionmailer/lib + vendor/rails/actionwebservice/lib + ).map { |dir| "#{RAILS_ROOT}/#{dir}" }.select { |dir| File.directory?(dir) } + end + + def default_log_path + File.join(RAILS_ROOT, 'log', "#{environment}.log") + end + + def default_log_level + environment == 'production' ? Logger::INFO : Logger::DEBUG + end + + def default_database_configuration_file + File.join(RAILS_ROOT, 'config', 'database.yml') + end + + def default_view_path + File.join(RAILS_ROOT, 'app', 'views') + end + + def default_controller_paths + [ File.join(RAILS_ROOT, 'app', 'controllers'), File.join(RAILS_ROOT, 'components') ] + end + end +end \ No newline at end of file diff --git a/railties/lib/rails_generator/generators/applications/app/app_generator.rb b/railties/lib/rails_generator/generators/applications/app/app_generator.rb index e8a3decffd..eee37be5c1 100644 --- a/railties/lib/rails_generator/generators/applications/app/app_generator.rb +++ b/railties/lib/rails_generator/generators/applications/app/app_generator.rb @@ -37,6 +37,7 @@ class AppGenerator < Rails::Generator::Base m.template "configs/apache.conf", "public/.htaccess" # Environments + m.file "environments/boot.rb", "config/boot.rb" m.file "environments/environment.rb", "config/environment.rb" m.file "environments/production.rb", "config/environments/production.rb" m.file "environments/development.rb", "config/environments/development.rb" diff --git a/railties/lib/tasks/databases.rake b/railties/lib/tasks/databases.rake new file mode 100644 index 0000000000..470fc07d35 --- /dev/null +++ b/railties/lib/tasks/databases.rake @@ -0,0 +1,93 @@ +desc "Migrate the database according to the migrate scripts in db/migrate (only supported on PG/MySQL). A specific version can be targetted with VERSION=x" +task :migrate => :environment do + ActiveRecord::Migrator.migrate(File.dirname(__FILE__) + '/db/migrate/', ENV["VERSION"] ? ENV["VERSION"].to_i : nil) +end + +desc "Load fixtures into the current environment's database" +task :load_fixtures => :environment do + require 'active_record/fixtures' + ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym) + Dir.glob(File.join(RAILS_ROOT, 'test', 'fixtures', '*.yml')).each do |fixture_file| + Fixtures.create_fixtures('test/fixtures', File.basename(fixture_file, '.*')) + end +end + +desc "Recreate the test databases from the development structure" +task :clone_structure_to_test => [ :db_structure_dump, :purge_test_database ] do + abcs = ActiveRecord::Base.configurations + case abcs["test"]["adapter"] + when "mysql" + ActiveRecord::Base.establish_connection(:test) + ActiveRecord::Base.connection.execute('SET foreign_key_checks = 0') + IO.readlines("db/#{RAILS_ENV}_structure.sql").join.split("\n\n").each do |table| + ActiveRecord::Base.connection.execute(table) + end + when "postgresql" + ENV['PGHOST'] = abcs["test"]["host"] if abcs["test"]["host"] + ENV['PGPORT'] = abcs["test"]["port"].to_s if abcs["test"]["port"] + ENV['PGPASSWORD'] = abcs["test"]["password"].to_s if abcs["test"]["password"] + `psql -U "#{abcs["test"]["username"]}" -f db/#{RAILS_ENV}_structure.sql #{abcs["test"]["database"]}` + when "sqlite", "sqlite3" + `#{abcs[RAILS_ENV]["adapter"]} #{abcs["test"]["dbfile"]} < db/#{RAILS_ENV}_structure.sql` + when "sqlserver" + `osql -E -S #{abcs["test"]["host"]} -d #{abcs["test"]["database"]} -i db\\#{RAILS_ENV}_structure.sql` + when "oci", + ActiveRecord::Base.establish_connection(:test) + IO.readlines("db/#{RAILS_ENV}_structure.sql").join.split(";\n\n").each do |ddl| + ActiveRecord::Base.connection.execute(ddl) + end + else + raise "Unknown database adapter '#{abcs["test"]["adapter"]}'" + end +end + +desc "Dump the database structure to a SQL file" +task :db_structure_dump => :environment do + abcs = ActiveRecord::Base.configurations + case abcs[RAILS_ENV]["adapter"] + when "mysql", "oci" + ActiveRecord::Base.establish_connection(abcs[RAILS_ENV]) + File.open("db/#{RAILS_ENV}_structure.sql", "w+") { |f| f << ActiveRecord::Base.connection.structure_dump } + when "postgresql" + ENV['PGHOST'] = abcs[RAILS_ENV]["host"] if abcs[RAILS_ENV]["host"] + ENV['PGPORT'] = abcs[RAILS_ENV]["port"].to_s if abcs[RAILS_ENV]["port"] + ENV['PGPASSWORD'] = abcs[RAILS_ENV]["password"].to_s if abcs[RAILS_ENV]["password"] + `pg_dump -U "#{abcs[RAILS_ENV]["username"]}" -s -x -O -f db/#{RAILS_ENV}_structure.sql #{abcs[RAILS_ENV]["database"]}` + when "sqlite", "sqlite3" + `#{abcs[RAILS_ENV]["adapter"]} #{abcs[RAILS_ENV]["dbfile"]} .schema > db/#{RAILS_ENV}_structure.sql` + when "sqlserver" + `scptxfr /s #{abcs[RAILS_ENV]["host"]} /d #{abcs[RAILS_ENV]["database"]} /I /f db\\#{RAILS_ENV}_structure.sql /q /A /r` + `scptxfr /s #{abcs[RAILS_ENV]["host"]} /d #{abcs[RAILS_ENV]["database"]} /I /F db\ /q /A /r` + else + raise "Unknown database adapter '#{abcs["test"]["adapter"]}'" + end +end + +desc "Empty the test database" +task :purge_test_database => :environment do + abcs = ActiveRecord::Base.configurations + case abcs["test"]["adapter"] + when "mysql" + ActiveRecord::Base.establish_connection(:test) + ActiveRecord::Base.connection.recreate_database(abcs["test"]["database"]) + when "postgresql" + ENV['PGHOST'] = abcs["test"]["host"] if abcs["test"]["host"] + ENV['PGPORT'] = abcs["test"]["port"].to_s if abcs["test"]["port"] + ENV['PGPASSWORD'] = abcs["test"]["password"].to_s if abcs["test"]["password"] + `dropdb -U "#{abcs["test"]["username"]}" #{abcs["test"]["database"]}` + `createdb -T template0 -U "#{abcs["test"]["username"]}" #{abcs["test"]["database"]}` + when "sqlite","sqlite3" + File.delete(abcs["test"]["dbfile"]) if File.exist?(abcs["test"]["dbfile"]) + when "sqlserver" + dropfkscript = "#{abcs["test"]["host"]}.#{abcs["test"]["database"]}.DP1".gsub(/\\/,'-') + `osql -E -S #{abcs["test"]["host"]} -d #{abcs["test"]["database"]} -i db\\#{dropfkscript}` + `osql -E -S #{abcs["test"]["host"]} -d #{abcs["test"]["database"]} -i db\\#{RAILS_ENV}_structure.sql` + when "oci" + ActiveRecord::Base.establish_connection(:test) + ActiveRecord::Base.connection.structure_drop.split(";\n\n").each do |ddl| + ActiveRecord::Base.connection.execute(ddl) + end + else + raise "Unknown database adapter '#{abcs["test"]["adapter"]}'" + end +end \ No newline at end of file diff --git a/railties/lib/tasks/documentation.rake b/railties/lib/tasks/documentation.rake new file mode 100644 index 0000000000..9d8fc6383c --- /dev/null +++ b/railties/lib/tasks/documentation.rake @@ -0,0 +1,44 @@ +desc "Generate documentation for the application" +Rake::RDocTask.new("appdoc") { |rdoc| + rdoc.rdoc_dir = 'doc/app' + rdoc.title = "Rails Application Documentation" + rdoc.options << '--line-numbers --inline-source' + rdoc.rdoc_files.include('doc/README_FOR_APP') + rdoc.rdoc_files.include('app/**/*.rb') +} + +desc "Generate documentation for the Rails framework" +Rake::RDocTask.new("apidoc") { |rdoc| + rdoc.rdoc_dir = 'doc/api' + rdoc.template = "#{ENV['template']}.rb" if ENV['template'] + rdoc.title = "Rails Framework Documentation" + rdoc.options << '--line-numbers --inline-source' + rdoc.rdoc_files.include('README') + rdoc.rdoc_files.include('CHANGELOG') + rdoc.rdoc_files.include('vendor/rails/railties/CHANGELOG') + rdoc.rdoc_files.include('vendor/rails/railties/MIT-LICENSE') + rdoc.rdoc_files.include('vendor/rails/activerecord/README') + rdoc.rdoc_files.include('vendor/rails/activerecord/CHANGELOG') + rdoc.rdoc_files.include('vendor/rails/activerecord/lib/active_record/**/*.rb') + rdoc.rdoc_files.exclude('vendor/rails/activerecord/lib/active_record/vendor/*') + rdoc.rdoc_files.include('vendor/rails/actionpack/README') + rdoc.rdoc_files.include('vendor/rails/actionpack/CHANGELOG') + rdoc.rdoc_files.include('vendor/rails/actionpack/lib/action_controller/**/*.rb') + rdoc.rdoc_files.include('vendor/rails/actionpack/lib/action_view/**/*.rb') + rdoc.rdoc_files.include('vendor/rails/actionmailer/README') + rdoc.rdoc_files.include('vendor/rails/actionmailer/CHANGELOG') + rdoc.rdoc_files.include('vendor/rails/actionmailer/lib/action_mailer/base.rb') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/README') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/CHANGELOG') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/lib/action_web_service.rb') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/lib/action_web_service/*.rb') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/lib/action_web_service/api/*.rb') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/lib/action_web_service/client/*.rb') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/lib/action_web_service/container/*.rb') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/lib/action_web_service/dispatcher/*.rb') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/lib/action_web_service/protocol/*.rb') + rdoc.rdoc_files.include('vendor/rails/actionwebservice/lib/action_web_service/support/*.rb') + rdoc.rdoc_files.include('vendor/rails/activesupport/README') + rdoc.rdoc_files.include('vendor/rails/activesupport/CHANGELOG') + rdoc.rdoc_files.include('vendor/rails/activesupport/lib/active_support/**/*.rb') +} \ No newline at end of file diff --git a/railties/lib/tasks/misc.rake b/railties/lib/tasks/misc.rake new file mode 100644 index 0000000000..713f622547 --- /dev/null +++ b/railties/lib/tasks/misc.rake @@ -0,0 +1,15 @@ +desc "Run all the tests on a fresh test database" +task :default => [ :test_units, :test_functional ] + +task :environment do + require(File.join(RAILS_ROOT, 'config', 'environment')) +end + + +desc "Clears all *.log files in log/" +task :clear_logs do + FileList["log/*.log"].each do |log_file| + f = File.open(log_file, "w") + f.close + end +end diff --git a/railties/lib/tasks/rails.rb b/railties/lib/tasks/rails.rb new file mode 100644 index 0000000000..28e4d8af80 --- /dev/null +++ b/railties/lib/tasks/rails.rb @@ -0,0 +1,7 @@ +$VERBOSE = nil + +# Load Rails rakefile extensions +Dir["#{File.dirname(__FILE__)}/*.rake"].each { |ext| load ext } + +# Load any custom rakefile extensions +Dir["./config/tasks/**/*.rake"].each { |ext| load ext } \ No newline at end of file diff --git a/railties/lib/tasks/statistics.rake b/railties/lib/tasks/statistics.rake new file mode 100644 index 0000000000..66b654725b --- /dev/null +++ b/railties/lib/tasks/statistics.rake @@ -0,0 +1,13 @@ +desc "Report code statistics (KLOCs, etc) from the application" +task :stats do + require 'code_statistics' + CodeStatistics.new( + ["Helpers", "app/helpers"], + ["Controllers", "app/controllers"], + ["APIs", "app/apis"], + ["Components", "components"], + ["Functionals", "test/functional"], + ["Models", "app/models"], + ["Units", "test/unit"] + ).to_s +end diff --git a/railties/lib/tasks/testing.rake b/railties/lib/tasks/testing.rake new file mode 100644 index 0000000000..3542b74763 --- /dev/null +++ b/railties/lib/tasks/testing.rake @@ -0,0 +1,40 @@ +TEST_CHANGES_SINCE = Time.now - 600 + +# Look up tests for recently modified sources. +def recent_tests(source_pattern, test_path, touched_since = 10.minutes.ago) + FileList[source_pattern].map do |path| + if File.mtime(path) > touched_since + test = "#{test_path}/#{File.basename(path, '.rb')}_test.rb" + test if File.exists?(test) + end + end.compact +end + +desc 'Test recent changes.' +Rake::TestTask.new(:recent => [ :clone_structure_to_test ]) do |t| + since = TEST_CHANGES_SINCE + touched = FileList['test/**/*_test.rb'].select { |path| File.mtime(path) > since } + + recent_tests('app/models/*.rb', 'test/unit', since) + + recent_tests('app/controllers/*.rb', 'test/functional', since) + + t.libs << 'test' + t.verbose = true + t.test_files = touched.uniq +end +task :test_recent => [ :clone_structure_to_test ] + +desc "Run the unit tests in test/unit" +Rake::TestTask.new("test_units") { |t| + t.libs << "test" + t.pattern = 'test/unit/**/*_test.rb' + t.verbose = true +} +task :test_units => [ :clone_structure_to_test ] + +desc "Run the functional tests in test/functional" +Rake::TestTask.new("test_functional") { |t| + t.libs << "test" + t.pattern = 'test/functional/**/*_test.rb' + t.verbose = true +} +task :test_functional => [ :clone_structure_to_test ] \ No newline at end of file -- cgit v1.2.3