README in joinfix-1.0.0 vs README in joinfix-1.0.1
- old
+ new
@@ -21,17 +21,21 @@
JoinFix uses reflection on ActiveRecord associations to determine how to perform joins so
no configuration is required. Simply require joinfix and begin writing entries.
== Info
-Available at {rubyforge.org/projects/joinfix}[http://rubyforge.org/projects/joinfix]
-
Copyright (c) 2006-2007, Regents of the University of Colorado.
-Developer:: Simon Chiang, Biomolecular Structure Program
-Support:: UCHSC School of Medicine Deans Academic Enrichment Fund
+Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com], {Biomolecular Structure Program}[http://biomol.uchsc.edu/], {Hansen Lab}[http://hsc-proteomics.uchsc.edu/hansenlab/]
+Support:: UC Denver School of Medicine Deans Academic Enrichment Fund
Licence:: MIT-Style
+== Installation
+
+Tap is available as a gem on RubyForge[http://rubyforge.org/projects/joinfix]. Use:
+
+ % gem install joinfix
+
== Usage
Consider the following data model:
class User < ActiveRecord::Base
has_many :user_groups
@@ -47,11 +51,11 @@
belongs_to :user
belongs_to :group
end
Write your fixtures using the naming scheme you lay out in your models.
-Entries can be referenced across multiple fixture files or defined inline:
+Entries can be referenced across multiple fixture files or defined inline:
[users.yml]
john_doe:
full_name: John Doe
groups: admin_group # => reference to the 'admin_group' entry
@@ -101,11 +105,13 @@
jane_doe_worker_group # => Notice the '<' operator in action
id: 3
user_id: 2
group_id: 1
-Note: Primary keys are assigned to entries based on the way the entry names are hashed, ie 'john_doe' will not necessarily have id '1'. If you need a specific id for an entry, then you must explicitly set it.
+Note: Primary keys are assigned to entries based on the way the entry names are
+hashed, ie 'john_doe' will not necessarily have id '1'. If you need a specific id for an
+entry, then you must explicitly set it as in the 'admin_group' entry.
If you need to add additional fields to an implied entry, simply define them in their
fixture file. All fields across all fixtures will be merged into one entry (JoinFix raises
an error in the event of a collision).
@@ -145,14 +151,14 @@
end
end
=== Command line options
-JoinFix provides some command line options through the ENV variables. Setting these
+JoinFix allows some command line options through the ENV variables. Setting these
variables is easy if you're using rake[http://rake.rubyforge.org/] to run your test suite:
% rake test key=value # => sets ENV['key'] = 'value'
Available options:
-format_joinfix_errors:: Unless 'false', this option causes JoinFix to simplify the console output when a JoinFixError occurs.
-joinfix_dump:: Prints all entries for tables matching joinfix_dump to STDOUT upon make_join_fixtures. Prints entries for all tables if 'true'.
+format_joinfix_errors:: Unless 'false', JoinFix will simplify the console output when a JoinFixError occurs.
+joinfix_dump:: Prints all entries for tables matching the value to STDOUT. Prints entries for all tables if 'true'.