/ 
App-RecordStream-4.0.25
River stage one • 1 direct dependent • 1 total dependent
/ recs-assert

NAME

recs-assert

recs-assert --help-all

Help from: --help-basic:
Usage: recs-assert <args> <expr> [<files>]
   Asserts that every record in the stream must pass the given <expr>.

   <expr> is evaluated as Perl on each record of input (or records from <files>)
   with $r set to a App::RecordStream::Record object and $line set to the
   current line number (starting at 1). If <expr> does not evaluate to true,
   processing is immediately aborted and an error message printed. See --help-
   snippets for more information on code snippets.

   --diagnostic|-d <text>       Include the diagnostic string <text> in any
                                failed assertion errors
   --verbose|-v                 Verbose output for failed assertions; dumps the
                                current record
   --e                          a perl snippet to execute, optional
   --E                          the name of a file to read as a perl snippet
   --M module[=...]             execute "use module..." before executing
                                snippet; same behaviour as perl -M
   --m module[=...]             same as -M, but by default import nothing
   --filename-key|fk <keyspec>  Add a key with the source filename (if no
                                filename is applicable will put NONE)

  Help Options:
      --help-all      Output all help for this script
      --help          This help screen
      --help-snippet  Help on code snippets

Examples:
   Require each record to have a "date" field.
      recs-assert '$r->{date}'

Help from: --help-snippet:
   CODE SNIPPETS:
    Recs code snippets are perl code, with one exception. There a couple of
    variables predefined for you, and one piece of special syntax to assist in
    modifying hashes.

Special Variables:
    $r - the current record object. This may be used exactly like a hash, or you
    can use some of the special record functions, see App::RecordStream::Record
    for more information

    $line - This is the number of records run through the code snippet, starting
    at 1. For most scripts this corresponds to the line number of the input to
    the script.

    $filename - The filename of the originating record. Note: This is only
    useful if you're passing filenames directly to the recs script, piping
    from other recs scripts or from cat, for instance, will not have a
    useful filename.

Special Syntax
    Use {{search_string}} to look for a string in the keys of a record, use /
    to nest keys. You can nest into arrays by using an index. If you are
    vivifying arrays (if the array doesn't exist, prefix your key with # so
    that an array rather than a hash will be created to put a / in your key,
    escape it twice, i.e. \/

    This is exactly the same as a key spec that is always prefaced with a @, see
    'man recs' for more info on key specs

    For example: A record that looks like:
    { "foo" : { "bar 1" : 1 }, "zoo" : 2}
    Could be accessed like this:

    # value of zoo  # value of $r->{foo}->{bar 1}: (comma separate nested keys)
    {{zoo}}         {{foo/ar 1}}

    # Even assign to values (set the foo key to the value 1)
    {{foo}} = 1

    # And auto, vivify
    {{new_key/array_key/#0}} = 3 # creates an array within a hash within a hash

    # Index into an array
    {{array_key/#3}} # The value of index 3 of the array ref under the
    'array_key' hash key.

    This matching is a fuzzy keyspec matching, see --help-keyspecs for
    more details.

SEE ALSO