Method: CSVDiff::Source#initialize

Defined in:
lib/csv-diff/source.rb

#initialize(options = {}) ⇒ Source

Creates a new diff source.

A diff source must contain at least one field that will be used as the key to identify the same record in a different version of this file. If not specified via one of the options, the first field is assumed to be the unique key.

If multiple fields combine to form a unique key, the combined fields are considered as a single unique identifier. If your key represents data that can be represented as a tree, you can instead break your key fields into :parent_fields and :child_fields. By doing this, if a child key is deleted from one parent, and added to another, that will be reported as an update, with a change to the parent key part(s) of the record.

All key options can be specified either by field name, or by field index (0 based).

Parameters:

  • options (Hash) (defaults to: {}) —

    An options hash.

Options Hash (options):

  • :field_names (Array<String>) —

    The names of each of the fields in source.

  • :ignore_header (Boolean) —

    If true, and :field_names has been specified, then the first row of the file is ignored.

  • :key_field (String) —

    The name of the field that uniquely identifies each row.

  • :key_fields (Array<String>) —

    The names of the fields that uniquely identifies each row.

  • :parent_field (String) —

    The name of the field(s) that identify a parent within which sibling order should be checked.

  • :child_field (String) —

    The name of the field(s) that uniquely identify a child of a parent.

  • :case_sensitive (Boolean) —

    If true (the default), keys are indexed as-is; if false, the index is built in upper-case for case-insensitive comparisons.

  • :include (Hash) —

    A hash of field name(s) or index(es) to regular expression(s). Only source rows whose field values satisfy the regular expressions will be indexed and included in the diff process.

  • :exclude (Hash) —

    A hash of field name(s) or index(es) to regular expression(s). Source rows with a field value that satisfies the regular expressions will be excluded from the diff process.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/csv-diff/source.rb', line 102

def initialize(options = {})
    if (options.keys & [:parent_field, :parent_fields, :child_field, :child_fields]).empty? &&
       (kf = options.fetch(:key_field, options[:key_fields]))
        @key_fields = [kf].flatten
        @parent_fields = []
        @child_fields = @key_fields
    else
        @parent_fields = [options.fetch(:parent_field, options[:parent_fields]) || []].flatten
        @child_fields = [options.fetch(:child_field, options[:child_fields]) || [0]].flatten
        @key_fields = @parent_fields + @child_fields
    end
    @field_names = options[:field_names]
    @case_sensitive = options.fetch(:case_sensitive, true)
    @trim_whitespace = options.fetch(:trim_whitespace, false)
    @ignore_header = options[:ignore_header]
    @include = options[:include]
    @exclued = options[:exclude]
    @path = options.fetch(:path, 'NA') unless @path
    @warnings = []
end