config/initializers/load_ansuz_task.rb vendor/plugins/has_settings/db/migrate/001_create_has_settings_settings.rb @@ -19,11 +19,13 @@ Ansuz is licensed via the BSD license. 1. clone from github: git clone git://github.com/knewter/ansuz.git 2. install gems: sudo rake gems:install - 2. rake ansuz:install + 3. create proper config/database.yml (note: install script supports this, but db script creation is bugged, so should be done externally from the script) + 3. create databases for development & test environments (note: install script is currently bugged for this) + 4. rake ansuz:install NOTE: SQLite has problems with ansuz, please don't use it for now. -NOTE: See the [Ansuz Site Laucher](http://github.com/knewter/ansuz_launcher/tree/master) +NOTE: See the [Ansuz Site Launcher](http://github.com/knewter/ansuz_launcher/tree/master) If run with sudo on a server with passenger set up and all the gems already installed, it will check out a new ansuz and set up a fresh database for it and set up a vhost README.markdown @@ -7,10 +7,11 @@ module Ansuz @themes = [] @stdin = stdin @stdout = stdout - @state = :started + @state = :started # this helps with the tests end - def choose_theme(theme_directory = File.join(RAILS_ROOT, "public", "themes")) + def choose_theme(theme_directory = File.join(RAILS_ROOT, "themes")) + FileUtils.mkdir_p( theme_directory ) unless File.directory?( theme_directory ) @themes = Dir.entries(theme_directory).select{|d| d =~ /^\w|^\d/}.collect{|theme| theme="- #{theme}"} if( @themes.any? ) @stdout.puts "[ansuz] Themes:\n" + @themes.join("\n") @@ -22,7 +23,11 @@ module Ansuz theme = @themes.detect{|t| t == theme_choice} if( theme ) @state = :theme_installed - return SiteSetting.find_or_create_by_name(:default).update_attribute(:user_theme_name, theme) + begin + return SiteSetting.find_or_create_by_name(:default).update_attribute(:user_theme_name, theme) + rescue + STDERR.puts "Badness happened trying to set the default theme. SQLite does this a lot." + end else @state = :invalid_theme @stdout.puts "[ansuz] invalid theme." @@ -30,72 +35,41 @@ module Ansuz end else @state = :no_themes_available - @stdout.puts "[ansuz]No themes available!" + @stdout.puts "[ansuz] No themes available!" + end + end + + def get_user_response_for(question, default_response="") + @state = :getting_user_response + @stdout.puts question + @stdin = rewind(@stdin) + response = @stdin.gets.chomp.strip + @state = :got_user_response + if( response.nil? || response.blank? ) + return default_response + else + return response end end def create_db_config(database_yaml_path = File.join(RAILS_ROOT, "config", "database.yml") ) unless( File.exists?( database_yaml_path ) ) - @stdout.puts "[ansuz] Database config does not exist? Would you like one created for you? (Rails will not boot until it has a valid db config)" - @state = :user_wants_database_yaml - response = @stdin.gets.chomp + response = get_user_response_for("[ansuz] Database config does not exist? Would you like one created for you? (Rails will not boot until it has a valid db config)") if( response =~ /^y|^yes/i ) + @state = :user_wants_database_yaml config = { } - @stdout.puts "[ansuz] Database Wizard: Which adapter will the CMS use? ( mysql, sqlite, etc) " - database_adapter = @stdin.gets.chomp.strip - database_adapter = "mysql" if database_adapter.blank? - config["adapter"] = database_adapter.downcase - if( database_adapter != "sqlite" ) - @stdout.puts "[ansuz] Host (localhost):" - database_host = @stdin.gets.chomp.strip - database_host = "localhost" if database_host.blank? - config["host"] = database_host - - @stdout.puts "[ansuz] Username (root):" - database_username = @stdin.gets.chomp.strip - database_username = "root" if database_username.blank? - config["user"] = database_username - - @stdout.puts "[ansuz] Password:" - database_password = @stdin.gets.chomp.strip - database_password = nil if database_password.blank? - config["password"] = database_password - - @stdout.puts "[ansuz] Socket (/var/run/mysqld/mysqld.sock): " - database_socket = @stdin.gets.chomp.strip - database_socket = "/var/run/mysqld/mysqld.sock" if database_socket.blank? - config["socket"] = database_socket - - @stdout.puts "[ansuz] Database Name Prefix (ansuz):" - database_prefix = @stdin.gets.chomp.strip - database_prefix = "ansuz" if database_prefix.blank? - config["database"] = database_prefix + config["adapter"] = get_user_response_for("[ansuz] Database Wizard: Which adapter will the CMS use? ( mysql, sqlite, etc) ", "mysql").downcase + if( config["adapter"] != "sqlite" ) + config["host"] = get_user_response_for("[ansuz] Host (localhost):", "localhost").downcase + config["user"] = get_user_response_for("[ansuz] Username (root):", "root") + config["password"] = get_user_response_for("[ansuz] Password:", nil) + config["socket"] = get_user_response_for("[ansuz] Socket (/var/run/mysqld/mysqld.sock): ", "/var/run/mysqld/mysqld.sock") + config["database"] = get_user_response_for("[ansuz] Database Name Prefix (ansuz):", "ansuz") else - @stdout.puts "[ansuz] Database Location (db/development.sqlite):" - database_location = @stdin.gets.chomp.strip - database_location = "db" if database_location.blank? - config["database"] = database_location - end - - database_config = {} - ["production","development","test"].each do |env| - database_config[env] = {} - config.each_pair do |key,val| - case key - when "database": - database_config[env][key] = val + "_" + env - when "location": - database_config[env][key] = val + "/#{env}.sqlite" - else - database_config[env][key] = val - end - end + config["database"] = get_user_response_for("[ansuz] Database Location (db/development.sqlite):", "db/") end - database_yaml = YAML::dump( database_config ).gsub(/^---/,'') - handle = File.open( File.join(RAILS_ROOT, "config", "database.yml"),"w" ) - handle.puts( database_yaml ) - handle.close + create_config_for_environment(["production","development","test"], config) @state = :database_yaml_created_successfully @stdout.puts "[ansuz] Database configuration created successfully" else @@ -108,55 +82,97 @@ module Ansuz def install unless( File.exists?( File.join(RAILS_ROOT, "config", "database.yml") ) ) - @stdout.puts "[ansuz]Please create a config/database.yml file before running this task." - return false + #@stdout.puts "[ansuz] Please create a config/database.yml file before running this task." + #return false + create_db_config end @stdout.puts "[ansuz] Creating database .." Kernel.silence_stream(@stdout) do - # FIXME - # Invoking db tasks causes a rollback of some kind during testing -james - #Rake::Task['db:create:all'].invoke - `rake db:create:all` + create_database end @stdout.puts "[ansuz] Migrating tables .." Kernel.silence_stream(@stdout) do - #Rake::Task['db:migrate'].invoke - `rake db:migrate` + migrate_database end @stdout.puts "[ansuz] Migrating plugins .." Kernel.silence_stream(@stdout) do - #Rake::Task['db:migrate:plugins'].invoke - `rake db:migrate:plugins` + migrate_plugins end - if( User.find(:all, :conditions => ["login = 'admin'"]).empty? ) - @stdout.puts "[ansuz] Enter a password for the default admin user:" - @stdout.flush - password = @stdin.gets.chomp - u = User.new :login => 'admin', :email => 'admin@example.com', :password => password, :password_confirmation => password - u.save - u.has_role 'admin' - u.save # Not sure why we save twice. Josh? - @stdout.puts "[ansuz] Admin user created with login 'admin' and the password you entered." - else - @stdout.puts "[ansuz] Admin user already exists." + # Create public/uploads directory for FCKeditor + create_fckeditor_uploads_dir + + choose_theme + @state = :installation_complete + end + + protected + + def create_config_for_environment( environments, config ) + @state = :creating_config + database_config = {} + environments.each do |environment| + database_config[environment] = {} + config.each_pair do |key,val| + case key + when "database": + database_config[environment][key] = val + "_" + environment + when "location": + database_config[environment][key] = val + "/#{environment}.sqlite" + else + database_config[environment][key] = val + end + end end - # Create public/uploads directory for FCKeditor + database_yaml = YAML::dump( database_config ).gsub(/^---/,'') + handle = File.open( File.join(RAILS_ROOT, "config", "database.yml"),"w" ) + handle.puts( database_yaml ) + handle.close + end + + def create_default_admin_user(password) + u = User.new :login => 'admin', :email => 'admin@example.com', :password => password, :password_confirmation => password + u.has_role 'admin' + u.save + @stdout.puts "[ansuz] Admin user created with login 'admin' and the password you entered." + end + + def create_fckeditor_uploads_dir + @state = :creating_fckeditor_uploads_dir unless( File.directory?( File.join(RAILS_ROOT, "public", "uploads") ) ) @stdout.puts "[ansuz] Creating public/uploads directory for FCKeditor.." - FileUtils.mkdir( File.join(RAILS_ROOT, "public", "uploads") ) + FileUtils.mkdir_p( File.join(RAILS_ROOT, "public", "uploads") ) + @state = :created_fckeditor_uploads_dir + else + @state = :fckeditor_uploads_dir_already_exists end + end - #Rake::Task["ansuz:choose_theme"].invoke - self.choose_theme + # FIXME: Somthing is causing this to be currently broken, should be fixed! + def create_database + @state = :creating_databases + system "rake db:create:all" + end - @stdout.puts "[ansuz] Finished! Start Ansuz with `script/server` on Linux or `ruby script/server` on Windows." + def migrate_database + @state = :migrating_database + system "rake db:migrate" end + def migrate_plugins + @state = :migrating_plugins + system "rake db:migrate:plugins" + end + def rewind(io) + if( io.is_a?(StringIO) ) # In non-test environment, we can't seek through STDIN, it gets rewound for us I suppose -james + io.rewind + end + io + end end end lib/ansuz/installer.rb @@ -1,145 +1,24 @@ require "yaml" +require File.join(File.dirname(__FILE__), "..","ansuz","installer.rb") +@installer = Ansuz::Installer.new namespace :ansuz do desc "Set the CMS theme" task(:choose_theme => :environment) do - themes = Dir.entries( File.join(RAILS_ROOT, "themes")).select{|d| d =~ /^\w|^\d/}.collect{|theme| theme="- #{theme}"} - if( themes.any? ) - STDOUT.puts "[ansuz] Themes:\n" + themes.join("\n") - STDOUT.puts "[ansuz] Enter a selection above, or leave blank for default" - theme_choice = $stdin.gets.chomp - unless( theme_choice.blank? ) - theme = theme_choice.detect{|t| t == theme_choice} - if( theme ) - SiteSetting.find_or_create_by_name(:default).update_attribute(:user_theme_name, theme) - else - STDOUT.puts "[ansuz] invalid theme." - end - end - else - STDOUT.puts "[ansuz] No themes available!" - end - + @installer.choose_theme end # Called at the beginning of the initializer in config/environment.rb before Rails complains about not having a db" desc "Build a basic database.yml" task(:create_db_config) do - unless( File.exists?( File.join(RAILS_ROOT, "config", "database.yml") ) ) - STDOUT.puts "[ansuz] Database config does not exist? Would you like one created for you? (Rails will not boot until it has a valid db config)" - response = $stdin.gets.chomp - if( response =~ /^y|^yes/i ) - config = { } - STDOUT.puts "[ansuz] Database Wizard: Which adapter will the CMS use? ( mysql, sqlite, etc) " - database_adapter = $stdin.gets.chomp.strip - database_adapter = "mysql" if database_adapter.blank? - config["adapter"] = database_adapter.downcase - if( database_adapter != "sqlite" ) - STDOUT.puts "[ansuz] Host (localhost):" - database_host = $stdin.gets.chomp.strip - database_host = "localhost" if database_host.blank? - config["host"] = database_host - - STDOUT.puts "[ansuz] Username (root):" - database_username = $stdin.gets.chomp.strip - database_username = "root" if database_username.blank? - config["user"] = database_username - - STDOUT.puts "[ansuz] Password:" - database_password = $stdin.gets.chomp.strip - database_password = nil if database_password.blank? - config["password"] = database_password - - STDOUT.puts "[ansuz] Socket (/var/run/mysqld/mysqld.sock): " - database_socket = $stdin.gets.chomp.strip - database_socket = "/var/run/mysqld/mysqld.sock" if database_socket.blank? - config["socket"] = database_socket - - STDOUT.puts "[ansuz] Database Name Prefix (ansuz):" - database_prefix = $stdin.gets.chomp.strip - database_prefix = "ansuz" if database_prefix.blank? - config["database"] = database_prefix - else - STDOUT.puts "[ansuz] Database Location (db/development.sqlite):" - database_location = $stdin.gets.chomp.strip - database_location = "db" if database_location.blank? - config["database"] = database_location - end - - database_config = {} - ["production","development","test"].each do |env| - database_config[env] = {} - config.each_pair do |key,val| - case key - when "database": - database_config[env][key] = val + "_" + env - when "location": - database_config[env][key] = val + "/#{env}.sqlite" - else - database_config[env][key] = val - end - end - end - - database_yaml = YAML::dump( database_config ).gsub(/^---/,'') - handle = File.open( File.join(RAILS_ROOT, "config", "database.yml"),"w" ) - handle.puts( database_yaml ) - handle.close - STDOUT.puts "[ansuz] Database configuration created successfully" - end - end + @installer.create_db_config end desc "Run all the necessary tasks to install Ansuz" - task(:install => :environment) do - - unless( File.exists?( File.join(RAILS_ROOT, "config", "database.yml") ) ) - STDOUT.puts "[ansuz]Please create a config/database.yml file before running this task." - return false - end - - STDOUT.puts "[ansuz] Creating database .." - Kernel.silence_stream(STDOUT) do - # FIXME - # Invoking db tasks causes a rollback of some kind during testing -james - #Rake::Task['db:create:all'].invoke - `rake db:create:all` - end - - STDOUT.puts "[ansuz] Migrating tables .." - Kernel.silence_stream(STDOUT) do - #Rake::Task['db:migrate'].invoke - `rake db:migrate` - end - - STDOUT.puts "[ansuz] Migrating plugins .." - Kernel.silence_stream(STDOUT) do - #Rake::Task['db:migrate:plugins'].invoke - `rake db:migrate:plugins` - end - - if( User.find(:all, :conditions => ["login = 'admin'"]).empty? ) - STDOUT.puts "[ansuz] Enter a password for the default admin user:" - STDOUT.flush - password = $stdin.gets.chomp - u = User.new :login => 'admin', :email => 'admin@example.com', :password => password, :password_confirmation => password - u.has_role 'admin' - u.save - STDOUT.puts "[ansuz] Admin user created with login 'admin' and the password you entered." - else - STDOUT.puts "[ansuz] Admin user already exists." - end - - # Create public/uploads directory for FCKeditor - unless( File.directory?( File.join(RAILS_ROOT, "public", "uploads") ) ) - STDOUT.puts "[ansuz] Creating public/uploads directory for FCKeditor.." - FileUtils.mkdir( File.join(RAILS_ROOT, "public", "uploads") ) - else - STDOUT.puts "[ansuz] public/uploads directory for FCKeditor already exists." - end - - Rake::Task["ansuz:choose_theme"].invoke - + task(:install) do + @installer.create_db_config + @installer.install + system("rake utils:create_admin") STDOUT.puts "[ansuz] Finished! Start Ansuz with `script/server` on Linux or `ruby script/server` on Windows." end lib/tasks/ansuz.rake @@ -3,6 +3,60 @@ require "stringio" # TODO CHECK FOR NO THEMES! describe Ansuz::Installer do + + describe "creating a database.yml" do + before(:each) do + @stdin = StringIO.new("","r+") # Fake STDIN + @stdout = StringIO.new("","r+") + @installer = Ansuz::Installer.new('test', @stdin, @stdout ) + @database_yaml_path = File.join(RAILS_ROOT, "config", "database.yml") + @database_yaml_backup_path = File.join(RAILS_ROOT, "config", "database.yml.bak") + + # Don't destroy the database config!! + if( !File.exists?( @database_yaml_backup_path ) && File.exists?( @database_yaml_path ) ) + FileUtils.cp( @database_yaml_path , @database_yaml_backup_path ) + end + + if( File.exists?( @database_yaml_path ) ) + FileUtils.rm( @database_yaml_path ) + end + end + + it "should not continue if the user enters a newline or anything other than y/yes" do + @stdin.write "banjo\n" + @stdin.rewind + @installer.create_db_config + @installer.state.should == :user_doesnt_want_database_yaml + end + + # You may be tempted to use sqlite for tests, but then you'd be in a world of pain. SQLite - is - the - devil + it "should prompt the user if he/she wants a database.yml created for them" do + @stdin.write "y\n" + @installer.create_db_config "pooptown" + @stdin.write "mysql\n" + @stdin.write "localhost" + @stdin.write "root" + @stdin.write "" + @stdin.write "\n" + @installer.state.should == :database_yaml_created_successfully + end + + it "should run all the necessary rake tasks to get ansuz running" do + @stdin.write "y\n" + @installer.install + @installer.state.should == :installation_complete + File.exists?( File.join(RAILS_ROOT, "db", "schema.rb" )).should == true + end + + after(:each) do + @stdout.truncate(0) + @stdin.close_write + if( File.exists?( @database_yaml_backup_path ) && !File.exists?( @database_yaml_path ) ) + FileUtils.cp( @database_yaml_backup_path , @database_yaml_path ) + end + end + end + describe "choosing a theme" do before(:each) do @stdin = StringIO.new("","r+") # Fake STDIN/STDOUT @@ -14,7 +68,7 @@ describe Ansuz::Installer do end it "should show a list of themes available" do - @stdin.write "a_test_theme\n" # We gotta write and rewind, or the method won't see anything + @stdin.write "a_test_theme\n" @stdin.rewind @installer.choose_theme( @theme_dir ) @@ -43,45 +97,5 @@ describe Ansuz::Installer do FileUtils.rm_r(@theme_dir) end end - - describe "creating a database.yml" do - before(:each) do - @stdin = StringIO.new("","r+") # Fake STDIN - @stdout = StringIO.new("","r+") - @installer = Ansuz::Installer.new('test', @stdin, @stdout ) - @database_yaml_path = File.join(RAILS_ROOT, "config", "database.yml") - @database_yaml_backup_path = File.join(RAILS_ROOT, "config", "database.yml.bak") - - # Don't destroy the database config!! - if( !File.exists?( @database_yaml_backup_path ) && File.exists?( @database_yaml_path ) ) - FileUtils.cp( @database_yaml_path , @database_yaml_backup_path ) - end - - if( File.exists?( @database_yaml_path ) ) - FileUtils.rm( @database_yaml_path ) - end - @stdout.truncate(0) - end - - it "should not continue if the user enters a newline or anything other than y/yes" do - @stdin.write "banjo\n" - @stdin.rewind - @installer.create_db_config - @installer.state.should == :user_doesnt_want_database_yaml - end - - it "should prompt the user if he/she wants a database.yml created for them" do - # @stdin.write "yes\n" - # @stdin.rewind - # @installer.create_db_config - # @installer.state.should == :user_wants_database_yaml - end - - after(:each) do - if( File.exists?( @database_yaml_backup_path ) && !File.exists?( @database_yaml_path ) ) - FileUtils.cp( @database_yaml_backup_path , @database_yaml_path ) - end - end - end end spec/ansuz_installer_spec.rb app/2 config/database.yml.bak db/schema.rb vendor/plugins/has_settings/db/migrate/20081220_create_has_settings_settings.rb f336466640ae6b21adc46f2c0b9c7db1ec71cc82 240e64694e38bcc28108391689150348f3452a99 Josh Adams jadams@goro.(none) http://github.com/knewter/ansuz/commit/a149cd63ed07bd6ea50e5f3c7bd5d4ab39984f6f a149cd63ed07bd6ea50e5f3c7bd5d4ab39984f6f 2009-02-10T05:19:00-08:00 2009-02-10T05:19:00-08:00 merged installer fdfbd516396d77c4db874f57743dc038f2d92ca7 Josh Adams jadams@goro.(none)