Class: IOStreams::Record::Reader

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/io_streams/record/reader.rb

Overview

Converts each line of an input stream into hash for every row

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(line_reader, cleanse_header: true, **args) ⇒ Reader

Create a Tabular reader to return the stream as Hash records Parse a delimited data source.

Parameters

delimited: [#each]
  Anything that returns one line / record at a time when #each is called on it.

format: [Symbol]
  :csv, :hash, :array, :json, :psv, :fixed

For all other parameters, see Tabular::Header.new



35
36
37
38
39
 
# File 'lib/io_streams/record/reader.rb', line 35

def initialize(line_reader, cleanse_header: true, **args)
  @tabular        = IOStreams::Tabular.new(**args)
  @line_reader      = line_reader
  @cleanse_header = cleanse_header
end

Class Method Details

.open(file_name_or_io, delimiter: nil, buffer_size: 65536, encoding: nil, encode_cleaner: nil, encode_replace: nil, **args) ⇒ Object

Read a record as a Hash at a time from a file or stream.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/io_streams/record/reader.rb', line 8

def self.open(file_name_or_io, delimiter: nil, buffer_size: 65536, encoding: nil, encode_cleaner: nil, encode_replace: nil, **args)
  if file_name_or_io.is_a?(String)
    IOStreams.line_reader(file_name_or_io,
                          delimiter:      delimiter,
                          buffer_size:    buffer_size,
                          encoding:       encoding,
                          encode_cleaner: encode_cleaner,
                          encode_replace: encode_replace
    ) do |io|
      yield new(io, file_name: file_name_or_io, **args)
    end
  else
    yield new(file_name_or_io, **args)
  end
end

Instance Method Details

#each ⇒ Object 



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/io_streams/record/reader.rb', line 41

def each
  @line_reader.each do |line|
    if @tabular.header?
      @tabular.parse_header(line)
      @tabular.cleanse_header! if @cleanse_header
    else
      yield @tabular.record_parse(line)
    end
  end
end