prophet::test::editor(3pm) [debian man page]

Prophet::Test::Editor(3pm)				User Contributed Perl Documentation				Prophet::Test::Editor(3pm)

METHODS

   edit( tmpl_files => $tmpl_files, edit_callback => sub {}, verify_callback => sub {} )
       Expects @ARGV to contain at least an option and a file to be edited. It can also contain a replica uuid, a ticket uuid, and a status file.
       The last item must always be the file to be edited. The others, if they appear, must be in that order after the option. The status file
       must contain the string 'status' in its filename.

       edit_callback is called on each line of the file being edited. It should make any edits to the lines it receives and then print what it
       wants to be saved to the file.

       verify_callback is called after editing is done. If you need to write whether the template was correct to a status file, for example, this
       should be done here.

   check_template_by_line($template, $valid_template, $errors)
       $template is a reference to an array containing the template to check, split into lines. $valid_template is the same for the template to
       check against. Lines in these arrays should not have trailing newlines.	$errors is a reference to an array where error messages will be
       stored.

       Lines in $valid_template should consist of either plain strings, or strings beginning with 'qr/' (to delimit a regexp object).

       Returns true if the templates match and false otherwise.

perl v5.10.1							    2009-12-22						Prophet::Test::Editor(3pm)

Prophet::Test(3pm)					User Contributed Perl Documentation					Prophet::Test(3pm)

   set_editor($code)
       Sets the subroutine that Prophet should use instead of "Prophet::CLI::Command::edit_text" (as this routine invokes an interactive editor)
       to $code.

   set_editor_script SCRIPT
       Sets the editor that Proc::InvokeEditor uses.

       This should be a non-interactive script found in t/scripts.

   import_extra($class, $args)
   in_gladiator($code)
       Run the given code using Devel::Gladiator.

   repo_path_for($username)
       Returns a path on disk for where $username's replica is stored.

   repo_uri_for($username)
       Returns a file:// URI for $USERNAME'S replica (with the correct replica type prefix).

   replica_uuid
       Returns the UUID of the test replica.

   database_uuid
       Returns the UUID of the test database.

   replica_last_rev
       Returns the sequence number of the last change in the test replica.

   as_user($username, $coderef)
       Run this code block as $username.  This routine sets up the %ENV hash so that when we go looking for a repository, we get the user's repo.

   replica_uuid_for($username)
       Returns the UUID of the given user's test replica.

   database_uuid_for($username)
       Returns the UUID of the given user's test database.

   ok_added_revisions( { CODE }, $numbers_of_new_revisions, $msg)
       Checks that the given code block adds the given number of changes to the test replica. $msg is optional and will be printed with the test
       if given.

   serialize_conflict($conflict_obj)
       Returns a simple, serialized version of a Prophet::Conflict object suitable for comparison in tests.

       The serialized version is a hash reference containing the following keys:
	   meta => { original_source_uuid => 'source_replica_uuid' }
	   records => { 'record_uuid' =>
			  { change_type => 'type',
			    props => { propchange_name => { source_old => 'old_val',
							    source_new => 'new_val',
							    target_old => 'target_val',
							  }
				     }
			  },
			'another_record_uuid' =>
			  { change_type => 'type',
			    props => { propchange_name => { source_old => 'old_val',
							    source_new => 'new_val',
							    target_old => 'target_val',
							  }
				     }
			  },
		      }

   serialize_changeset($changeset_obj)
       Returns a simple, serialized version of a Prophet::ChangeSet object suitable for comparison in tests (a hash).

   run_command($command, @args)
       Run the given command with (optionally) the given args using a new Prophet::CLI object. Returns the standard output of that command in
       scalar form or, in array context, the STDOUT in scalar form *and* the STDERR in scalar form.

       Examples:

	   run_command('create', '--type=Foo');

   load_record($type, $uuid)
       Loads and returns a record object for the record with the given type and uuid.

   as_alice CODE, as_bob CODE, as_charlie CODE, as_david CODE
       Runs CODE as alice, bob, charlie or david.

perl v5.10.1							    2009-09-02							Prophet::Test(3pm)