Class YamlFixture

Uses the Spyc library to parse a YAML document (see http://yaml.org). YAML is a simple markup languages that uses tabs and colons instead of the more verbose XML tags, and because of this much better for developers creating files by hand.

The contents of the YAML file are broken into three levels:

• Top level: class names - Page and ErrorPage. This is the name of the dataobject class that should be created. The fact that ErrorPage is actually a subclass is irrelevant to the system populating the database. Each identifier you specify delimits a new database record. This means that every record needs to have an identifier, whether you use it or not.
• Third level: fields - each field for the record is listed as a 3rd level entry. In most cases, the fieldŐs raw content is provided. However, if you want to define a relationship, you can do so using "=>"

There are a couple of lines like this:

Parent: =>Page.about

This will tell the system to set the ParentID database field to the ID of the Page object with the identifier ŇaboutÓ. This can be used on any has-one or many-many relationship. Note that we use the name of the relationship (Parent), and not the name of the database field (ParentID)

On many-many relationships, you should specify a comma separated list of values.

MyRelation: =>Class.inst1,=>Class.inst2,=>Class.inst3

An crucial thing to note is that the YAML file specifies DataObjects, not database records. The database is populated by instantiating DataObject objects, setting the fields listed, and calling write(). This means that any onBeforeWrite() or default value logic will be executed as part of the test. This forms the basis of our testURLGeneration() test above.

For example, the URLSegment value of Page.staffduplicate is the same as the URLSegment value of Page.staff. When the fixture is set up, the URLSegment value of Page.staffduplicate will actually be my-staff-2.

Finally, be aware that requireDefaultRecords() is not called by the database populator - so you will need to specify standard pages such as 404 and home in your YAML file.

Page:
   home:
      Title: Home
   about:
      Title: About Us
   staff:
      Title: Staff
      URLSegment: my-staff
      Parent: =>Page.about
   staffduplicate:
      Title: Staff
      URLSegment: my-staff
      Parent: =>Page.about
   products:
      Title: Products
ErrorPage:
   404:
     Title: Page not Found
     ErrorCode: 404