Class: NdrImport::Table
- Inherits:
-
Object
- Object
- NdrImport::Table
- Includes:
- Mapper
- Defined in:
- lib/ndr_import/table.rb
Overview
This class maintains the state of a table mapping and encapsulates the logic required to transform a table of data into “records”. Particular attention has been made to use enumerables throughout to help with the transformation of large quantities of data.
Direct Known Subclasses
FixedWidth::Table, NonTabular::Table, PdfForm::Table, Xml::Table
Instance Attribute Summary collapse
-
#notifier ⇒ Object
Returns the value of attribute notifier.
Class Method Summary collapse
Instance Method Summary collapse
- #all_valid_options ⇒ Object
-
#encode_with(coder) ⇒ Object
For readability, we should serialise the columns last.
- #header_valid? ⇒ Boolean
-
#initialize(options = {}) ⇒ Table
constructor
A new instance of Table.
- #match(filename, tablename) ⇒ Object
-
#process_line(line, &block) ⇒ Object
This method process a line of data, If it is a header line it validates it, otherwise transforms it.
-
#transform(lines, &block) ⇒ Object
This method transforms a table of data, given a line array/enumerator and yields klass, fields and index (input row number) for each record that it would create as a result of the transformation process.
-
#transform_line(line, index) ⇒ Object
This method transforms an incoming line of data by applying each of the klass masked mappings to the line and yielding the klass and fields for each mapped klass.
Constructor Details
#initialize(options = {}) ⇒ Table
Returns a new instance of Table.
24 25 26 27 28 29 30 31 32 33 34 35 |
# File 'lib/ndr_import/table.rb', line 24 def initialize( = {}) .stringify_keys! if .is_a?(Hash) () .each do |key| # This pattern is used to only set attributes if option specified, # which makes for more concise YAML serialization. [key] && instance_variable_set("@#{key}", [key]) end @row_index = 0 end |
Instance Attribute Details
#notifier ⇒ Object
Returns the value of attribute notifier.
22 23 24 |
# File 'lib/ndr_import/table.rb', line 22 def notifier @notifier end |
Class Method Details
.all_valid_options ⇒ Object
12 13 14 15 |
# File 'lib/ndr_import/table.rb', line 12 def self. %w[canonical_name delimiter liberal_parsing filename_pattern file_password tablename_pattern header_lines footer_lines format klass columns xml_record_xpath row_identifier] end |
Instance Method Details
#all_valid_options ⇒ Object
17 18 19 |
# File 'lib/ndr_import/table.rb', line 17 def self.class. end |
#encode_with(coder) ⇒ Object
For readability, we should serialise the columns last
104 105 106 107 108 109 110 111 |
# File 'lib/ndr_import/table.rb', line 104 def encode_with(coder) = self.class. - ['columns'] .each do |option| value = send(option) coder[option] = value if value end coder['columns'] = @columns end |
#header_valid? ⇒ Boolean
99 100 101 |
# File 'lib/ndr_import/table.rb', line 99 def header_valid? @header_valid == true end |
#match(filename, tablename) ⇒ Object
37 38 39 40 |
# File 'lib/ndr_import/table.rb', line 37 def match(filename, tablename) ::File.basename(filename) =~ (filename_pattern || /\A.*\z/) && (tablename.nil? || tablename =~ (tablename_pattern || /\A.*\z/)) end |
#process_line(line, &block) ⇒ Object
This method process a line of data, If it is a header line it validates it, otherwise transforms it. It also increments the row index and notifies the amount of lines processed.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/ndr_import/table.rb', line 62 def process_line(line, &block) return enum_for(:process_line, line) unless block if @row_index < header_lines consume_header_line(line, @columns) else transform_line(line, @row_index, &block) end @row_index += 1 # We've now seen enough lines to have consumed a valid header; is this the case? fail_unless_header_complete(@columns) if @row_index == header_lines @notifier.try(:processed, @row_index) end |
#transform(lines, &block) ⇒ Object
This method transforms a table of data, given a line array/enumerator and yields klass, fields and index (input row number) for each record that it would create as a result of the transformation process.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/ndr_import/table.rb', line 45 def transform(lines, &block) return enum_for(:transform, lines) unless block @row_index = 0 @header_valid = false @header_best_guess = nil @notifier.try(:started) (lines, ).each do |line| process_line(line, &block) end @notifier.try(:finished) end |
#transform_line(line, index) ⇒ Object
This method transforms an incoming line of data by applying each of the klass masked mappings to the line and yielding the klass and fields for each mapped klass.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/ndr_import/table.rb', line 81 def transform_line(line, index) return enum_for(:transform_line, line, index) unless block_given? identifier = case @row_identifier.to_s when 'index' index when 'uuid' SecureRandom.uuid end masked_mappings.each do |klass, klass_mappings| fields = mapped_line(line, klass_mappings) fields['row_identifier'] = identifier unless identifier.nil? next if fields[:skip].to_s == 'true' yield(klass, fields, index) end end |