@@ -1,73 +1,92 @@ -rubychecker - runs checks on a Ruby interpreter -USAGE: rubychecker.sh [OPTIONS] +RUBYCHECKER - RUNS CHECKS ON A RUBY INTERPRETER +=============================================== -OPTIONS: - -t tag - Name of interpreter to use when naming reports, e.g., "p111" or - "svn12345". Defaults to "current". +USAGE +----- + rubychecker.rb [options] [suite or suites to run] - -v - Displays version number and quits. - -C - Skip checkouts +OPTIONS +------- + * -t TAG + A tag to include in the filenames of the reports, e.g., a tag of + "p111" may create report files like "rspec_1.1.4_with_p111.log" + * -v + Displays version information and exits. + * -h + Displays this help information and exits. + * -f + Freshens existing checkouts (git pull, svn update, etc). + * -p + Prepares dependencies and exits without running checks. - -S - Skip all preparations that can be skipped -BASIC EXAMPLE: - # Runs test suites against the "ruby" interpreter in your current - # shell's PATH and records them to the "reports" directory: +BASIC EXAMPLE +------------- + # Runs test suites against the "ruby" interpreter in your current + # shell's PATH and records them to the "reports" directory: - ./rubychecker.sh + ./rubychecker.rb -COMPLETE EXAMPLE: - # Download, compile and check a Ruby interpreter from SVN: - rubysvn=$PWD/cache/ruby - rubytmp=$PWD/tmp/ruby - export PATH=$rubytmp/bin:$PATH - mkdir -p cache - svn co http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8_6 $rubysvn - pushd $rubysvn - autoconf - ./configure --prefix=$rubytmp && make && make install - popd - ./rubychecker.sh -t svn186 +COMPLEX EXAMPLE +--------------- + # Download, compile and check a Ruby interpreter from SVN: + + rubysvn=$PWD/cache/ruby + rubytmp=$PWD/tmp/ruby + export PATH=$rubytmp/bin:$PATH + mkdir -p cache + svn co http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8_6 $rubysvn + pushd $rubysvn + autoconf + ./configure --prefix=$rubytmp && make && make install + popd + ./rubychecker.rb -t svn186 + DEPENDENCIES: - - ruby - - ruby headers - - complete build environment, e.g., gcc, make, etc - - bash - - grep - - git - - svn - - unzip - - MySQL headers - - SQLite3 headers - - MySQL server - You'll need to login as DBA and run: - CREATE DATABASE activerecord_unittest; - CREATE DATABASE activerecord_unittest2; - CREATE DATABASE actionwebservice_unittest; - CREATE USER 'rails'@'localhost' IDENTIFIED BY PASSWORD ''; - GRANT ALL ON activerecord_unittest.* TO 'rails'@'localhost'; - GRANT ALL ON activerecord_unittest2.* TO 'rails'@'localhost'; - GRANT ALL ON actionwebservice_unittest.* TO 'rails'@'localhost'; - FLUSH PRIVILEGES; +------------- + * ruby + * ruby headers + * complete build environment, e.g., gcc, make, etc + * grep + * git + * svn + * unzip + * MySQL headers + * SQLite3 headers + * MySQL server + You'll need to login as DBA and run: + CREATE DATABASE activerecord_unittest; + CREATE DATABASE activerecord_unittest2; + CREATE DATABASE actionwebservice_unittest; + CREATE USER 'rails'@'localhost' IDENTIFIED BY PASSWORD ''; + GRANT ALL ON activerecord_unittest.* TO 'rails'@'localhost'; + GRANT ALL ON activerecord_unittest2.* TO 'rails'@'localhost'; + GRANT ALL ON actionwebservice_unittest.* TO 'rails'@'localhost'; + FLUSH PRIVILEGES; + WHAT DOESN'T WORK YET: - - Any OS other than UNIX - - Any Ruby interpreter other than MRI 1.8 +---------------------- + * Any OS other than UNIX + * Any Ruby interpreter other than MRI 1.8 + + +SOURCE CODE: +------------ + http://github.com/igal/rubychecker -SOURCE CODE: - http://github.com/igal/rubycheck_sh ISSUE TRACKER: - http://code.google.com/p/rubychecker - +-------------- + http://code.google.com/p/rubychecker + + LICENSE: - This program is provided under the same license as Ruby: - http://www.ruby-lang.org/en/LICENSE.txt +-------- + This program is provided under the same license as Ruby: + http://www.ruby-lang.org/en/LICENSE.txt + README.txt @@ -4,7 +4,7 @@ # # == USAGE # -# rubychecker.sh [options] [suite or suites to run] +# rubychecker.rb [options] [suite or suites to run] # # == OPTIONS # @@ -46,7 +46,6 @@ # * ruby # * ruby headers # * complete build environment, e.g., gcc, make, etc -# * bash # * grep # * git # * svn @@ -71,7 +70,7 @@ # # == SOURCE CODE: # -# http://github.com/igal/rubycheck_sh +# http://github.com/igal/rubychecker # # == ISSUE TRACKER: # @@ -330,6 +329,11 @@ if __FILE__ == $0 targets.concat(ARGV) + if targets.first == "README.txt" + system "'#{__FILE__}' --help > README.txt" + exit 0 + end + rc.prepare rc.check(*targets) unless prepare_only end rubychecker.rb rubychecker.sh 3de2e7e2b2553b032b2e7ebfa7dfec8849fc429e Igal Koshevoy igal@pragmaticraft.com http://github.com/igal/rubychecker/commit/e71dc942b52bb0ea8f0cc15f6619aef87b21652b e71dc942b52bb0ea8f0cc15f6619aef87b21652b 2008-07-04T10:32:29-07:00 2008-07-04T10:32:29-07:00 Forked code for Ruby-only version 888e100e123039b215b25a6798c36b71141dfe0d Igal Koshevoy igal@pragmaticraft.com