@@ -1,6 +1,9 @@ #!/usr/bin/env ruby require 'rubygems' +require 'yaml' +require 'pp' + module ContributeHelper; end class Contribute @@ -10,6 +13,7 @@ class Contribute [ Dependencies::Sphinx, Dependencies::Mysql, + Dependencies::AR, Dependencies::Ginger ] end @@ -18,9 +22,9 @@ class Contribute show_welcome_screen ( - check_for_dependencies && - create_database_yaml && - check_mysql_gem_is_working && + check_for_dependencies && + create_database_yaml && + check_mysql_is_working && create_test_database ) || exit(1) @@ -33,62 +37,175 @@ WELCOME_SCREEN = <<-EO_WELCOME Thanks for contributing to Thinking Sphinx. -In this script we'll help you get started contributing to Thinking Sphinx +In this script we'll help you get setup to hack: + + 1. We'll check that you have the right software installed and running. + 2. We'll set up the test database for specs to run against. EO_WELCOME +DONE_SCREEN = <<-EO_DONE +<banner>Setup done!</banner> + +All done! Now you can start hacking by running + + rake spec + +EO_DONE + +REVIEW_YAML = <<-EO_REVIEW_YAML + +Please review the database details in the yaml file details before continuing. + +This file is used by the specs to connect to the database. + +Current details: +EO_REVIEW_YAML + + + +MYSQL_FAILED = <<-EO_MYSQL_FAILED + +Looks like we couldn't successfully talk to the mysql database. + +Don't worry though... + +EO_MYSQL_FAILED + +CREATE_DATABASE_FAILED = <<-EO_CREATE_DATABASE_FAILED + +Looks like we couldn't create a test database to work against. + +Don't worry though... + +EO_CREATE_DATABASE_FAILED + def show_welcome_screen colour_puts WELCOME_SCREEN + wait! end def show_done_screen - puts "done!" + colour_puts DONE_SCREEN end - - def check_for_dependencies - colour_puts "<banner>Checking for required software</banner>" + + # create database.yml + def create_database_yaml + colour_puts "<banner>creating database yaml</banner>" puts - all_found = true - dependencies.each do |klass| - dep = klass.new - print " * #{dep.name}... " - dep.check! - - if dep.found? - if dep.location - colour_puts "<green>found at #{dep.location}</green>" - else - colour_puts "<green>found</green>" - end - else - all_found &= false - colour_puts "<red>not found</red>" - end + config = { + 'username' => 'root', + 'password' => nil, + 'host' => 'localhost' + } + + + colour_print " * #{db_yml}... " + unless File.exist?(db_yml) + open(db_yml,'w') {|f| f << config.to_yaml} + colour_puts "<green>created</green>" + else + config = YAML.load_file(db_yml) + colour_puts "<green>already exists</green>" + end + + colour_puts REVIEW_YAML + + config.each do |(k,v)| + colour_puts " * #{k}: #{v}" end puts - all_found + wait! + true end - + def check_mysql_is_working - colour_puts "<banner>check mysql gem is working</banner>" - false - end - - # create database.yml - def create_database_yaml - colour_puts "<banner>creating database yaml</banner>" + require 'activerecord' + colour_puts "<banner>check mysql is working</banner>" + puts + + connect_to_db + + print " * connecting to mysql... " + + begin + ActiveRecord::Base.connection.select_value('select sysdate() from dual') + + colour_puts "<green>successful</green>" + puts + + return true + rescue Mysql::Error + colour_puts "<red>failed</red>" + + puts MYSQL_FAILED + end + false end # create test db def create_test_database colour_puts "<banner>create test database</banner>" + puts + + connect_to_db + + colour_print " * creating thinking_sphinx database... " + begin + ActiveRecord::Base.connection.create_database('thinking_sphinx') + colour_puts "<green>successful</green>" + rescue ActiveRecord::StatementInvalid + if $!.message[/database exists/] + colour_puts "<green>successful</green> (database already existed)" + puts + return true + else + colour_puts "<red>failed</red>" + end + end + + colour_puts CREATE_DATABASE_FAILED + false end + + # project + def ts_root + File.expand_path(File.dirname(__FILE__)) + end + + def specs + ts_root / 'spec' + end + + def db_yml + specs / 'fixtures' / 'database.yml' + end + + def connect_to_db + config = YAML.load_file(db_yml) + config.update(:adapter => 'mysql', :database => 'test') + config.symbolize_keys! + + ActiveRecord::Base.establish_connection(config) + end +end + + + + + + + +class String + def /(other) + "#{self}/#{other}" + end end module ContributeHelper @@ -126,6 +243,35 @@ module ContributeHelper end + def check_for_dependencies + colour_puts "<banner>Checking for required software</banner>" + puts + + all_found = true + + dependencies.each do |klass| + dep = klass.new + print " * #{dep.name}... " + dep.check! + + if dep.found? + if dep.location + colour_puts "<green>found at #{dep.location}</green>" + else + colour_puts "<green>found</green>" + end + else + all_found &= false + colour_puts "<red>not found</red>" + end + end + + puts + + all_found + end + + DEFAULT_TERMINAL_COLORS = "\e[0m\e[37m\e[40m" def subs_colour(data) @@ -141,6 +287,18 @@ module ContributeHelper def colour_puts(text) puts subs_colour(text) end + + def colour_print(text) + print subs_colour(text) + end + + + def wait! + colour_puts "Hit Enter to continue, or Ctrl-C to quit." + STDIN.readline + rescue Interrupt + exit! + end end module Dependencies @@ -148,6 +306,10 @@ module Dependencies name 'mysql' end + class AR < ContributeHelper::Gem + name 'activerecord' + end + class Ginger < ContributeHelper::Gem name 'ginger' end contribute.rb d723846cce37aa6c69e08e0d1a17ccaaafc6e5d9 lachie lachiec@gmail.com http://github.com/isaacfeliu/thinking-sphinx/commit/63739b5d2ff0c52b9f77e0e3339464a84a6f9f67 63739b5d2ff0c52b9f77e0e3339464a84a6f9f67

2009-01-08T14:43:55-08:00

finished basic contribute script 6c341779b9588134301070cc4a3f9a3d4a4a0a3a lachie lachiec@gmail.com