@@ -1,12 +1,40 @@ Developing the invoicing gem ============================ -You need to set up a test database, using something like (for MySQL, the default): +For development, you need up-to-date versions of the following gems (`sudo gem install <gemname>`): - $ echo "create database ept_invoicing_test" | mysql -uroot + * rake + * activerecord + * mysql (if you use MySQL) + * pg (if you use PostgreSQL) + * newgem + * flexmock + +Fork the invoicing gem on GitHub, then clone it to your machine: + + $ git clone git@github.com:YOUR-GITHUB-USERNAME/invoicing.git + + +MySQL +----- + +You need to set up a test database. You can modify the settings for the test database in +`config/database.yml`, but if you stick with the defaults, you can set up the database like this: + $ echo "create database ept_invoicing_test" | mysql -uroot $ echo "grant all on ept_invoicing_test.* to 'build'@'%'" | mysql -uroot Then run the tests by typing `rake`. -FIXME: add notes on Postgres, testing different gem versions, testing different Ruby versions, ... + +PostgreSQL +---------- + +To set up the test database, run something like the following as root: + + # su -c 'createuser -SDRP invoicing' postgres # (enter "password" as password) + # su -c 'createdb -O invoicing invoicing_test' postgres + +Then run the tests by typing: + + $ DATABASE=postgresql rake HACKING.md @@ -13,7 +13,7 @@ require 'invoicing' # Overridden by ../../config/database.yml if it exists. TEST_DB_CONFIG = { :postgresql => {:adapter => "postgresql", :host => "localhost", :database => "invoicing_test", - :username => "postgres", :password => ""}, + :username => "invoicing", :password => "password"}, :mysql => {:adapter => "mysql", :host => "localhost", :database => "invoicing_test", :username => "root", :password => ""} } invoicing/test/test_helper.rb 124a9adf61451f8639a4674ca2296810d6da70df Martin Kleppmann martin@eptcomputing.com http://github.com/ept/invoicing/commit/39d5259d884556aaaf9aa36bd4c5ccc513ef8c37 39d5259d884556aaaf9aa36bd4c5ccc513ef8c37 2009-08-26T06:44:21-07:00 2009-08-26T06:44:21-07:00 Updated info for running Postgres tests f0d009a13b145ba3d94542a79ab48eb5edff156b Martin Kleppmann martin@eptcomputing.com