Class: WindowsCsv

Inherits:
Object
  • Object
show all
Defined in:
lib/windows_csv.rb

Overview

This class was heavily inspired by the great Dipth! github.com/dipth

Constant Summary collapse

BOM =

Byte Order Mark

"\377\376".force_encoding(Encoding::UTF_16LE)
COL_SEP = 
";".freeze
QUOTE_CHAR = 
"\"".freeze
ROW_SEP = 
"\r\n".freeze
ARGS =

rubocop:disable Style/MutableConstant

{ # rubocop:disable Style/MutableConstant
  col_sep: COL_SEP,
  quote_char: QUOTE_CHAR,
  row_sep: ROW_SEP
}
REPLACES = 
{
  "\r\n" => "\\r\\n",
  "\r" => "\\r",
  "\n" => "\\n"
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ WindowsCsv

Returns a new instance of WindowsCsv.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/windows_csv.rb', line 50

def initialize(args)
  require "csv"

  @args = args

  if @args[:path]
    fp = File.open(@args[:path], "w", encoding: Encoding::UTF_8)
    @args[:io] = fp
  end

  begin
    @args[:io].write(BOM)
    yield self
  ensure
    fp&.close
  end
end

Class Method Details

.escape(str) ⇒ Object 



86
87
88
89
90
91
92
93
94
 
# File 'lib/windows_csv.rb', line 86

def self.escape(str)
  str = str.to_s

  REPLACES.each do |key, val|
    str = str.gsub(key, val)
  end

  str
end

.foreach(path, args = {}) ⇒ Object

Loops through a Windows CSV file with leading BOM, tabs as col-sep, quote char “ and row sep rn



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/windows_csv.rb', line 21

def self.foreach(path, args = {}) # rubocop:disable Metrics/AbcSize
  require "csv"

  File.open(path, "rb:bom|utf-16le") do |fp|
    csv_args = ARGS.clone
    csv_args.merge!(args[:csv_args]) if args[:csv_args]

    CSV.foreach(fp, **csv_args) do |row|
      if csv_args[:headers]
        real = {}
      else
        real = []
      end

      row.each do |col|
        if csv_args[:headers]
          real[col[0].to_sym] = WindowsCsv.unescape(col[1])
        else
          real << WindowsCsv.unescape(col)
        end
      end

      yield real
    end
  end

  nil
end

.unescape(str) ⇒ Object 



96
97
98
99
100
101
102
103
104
 
# File 'lib/windows_csv.rb', line 96

def self.unescape(str)
  str = str.to_s

  REPLACES.each do |key, val|
    str = str.gsub(val, key)
  end

  str
end

Instance Method Details

#<<(row) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/windows_csv.rb', line 68

def <<(row)
  encoded = []

  row.each do |col|
    if col.is_a?(Time) || col.is_a?(DateTime)
      encoded << col.strftime("%Y-%m-%d %H:%M")
    elsif col.is_a?(Date)
      encoded << col.strftime("%Y-%m-%d")
    else
      encoded << WindowsCsv.escape(col)
    end
  end

  @args[:io].write CSV.generate_line(encoded, **ARGS).encode(Encoding::UTF_16LE)

  nil
end