Class: Phlex::CSV

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

Constant Summary collapse

FORMULA_PREFIXES_MAP = 
Array.new(128).tap do |map|
	"=+-@\t\r".each_byte do |byte|
		map[byte] = true
	end
end.freeze
UNDEFINED = 
Object.new

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collection) ⇒ CSV

Returns a new instance of CSV.



12
13
14
15
16
17
 
# File 'lib/phlex/csv.rb', line 12

def initialize(collection)
	@collection = collection
	@_row_buffer = []
	@_headers = []
	@_row_appender = nil
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name) ⇒ Object (private)

Handle legacy ‘view_template` method



224
225
226
227
228
229
230
231
232
 
# File 'lib/phlex/csv.rb', line 224

private def method_missing(method_name, ...)
	if method_name == :row_template && respond_to?(:view_template)
		warn "Deprecated: Use `row_template` instead of `view_template` in Phlex CSVs."
		self.class.alias_method :row_template, :view_template
		view_template(...)
	else
		super
	end
end

Instance Attribute Details

#collection ⇒ Object (readonly)

Returns the value of attribute collection.



19
20
21
 
# File 'lib/phlex/csv.rb', line 19

def collection
  @collection
end

Instance Method Details

#around_row ⇒ Object 



125
126
127
128
 
# File 'lib/phlex/csv.rb', line 125

def around_row(...)
	row_template(...)
	@row_appender.call
end

#call(buffer = +"",, context: nil, delimiter: self.delimiter) ⇒ Object 



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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/phlex/csv.rb', line 21

def call(buffer = +"", context: nil, delimiter: self.delimiter)
	ensure_escape_csv_injection_configured!

	strip_whitespace = trim_whitespace?
	escape_csv_injection = escape_csv_injection?
	row_buffer = @_row_buffer
	headers = @_headers
	has_yielder = respond_to?(:yielder, true)
	first_row = true
	render_headers = render_headers?

	if delimiter.length != 1
		raise Phlex::ArgumentError.new("Delimiter must be a single character")
	end

	if strip_whitespace
		escape_regex = /[\n"#{delimiter}]/
	else
		escape_regex = /^\s|\s$|[\n"#{delimiter}]/
	end

	if has_yielder
		warn <<~MESSAGE
			Custom yielders are deprecated in Phlex::CSV.

			Please replace your yielder with an `around_row` method.

			You should be able to just rename your yielder method
			and change `yield` to `super`.
		MESSAGE
	end

	row_appender = -> {
		row = row_buffer

		if first_row
			first_row = false

			i = 0
			number_of_columns = row.length
			first_col = true

			while i < number_of_columns
				header, = row[i]
				headers[i] = header

				if render_headers
					if first_col
						first_col = false
					else
						buffer << delimiter
					end

					__escape__(buffer, header, escape_csv_injection:, strip_whitespace:, escape_regex:)
				end
				i += 1
			end

			buffer << "\n" if render_headers
		end

		i = 0
		number_of_columns = row.length
		first_col = true

		while i < number_of_columns
			header, value = row[i]

			unless headers[i] == header
				raise Phlex::RuntimeError.new("Header mismatch at index #{i}: expected #{headers[i]}, got #{header}.")
			end

			if first_col
				first_col = false
			else
				buffer << delimiter
			end

			__escape__(buffer, value, escape_csv_injection:, strip_whitespace:, escape_regex:)
			i += 1
		end

		buffer << "\n"

		row_buffer.clear
	}

	if has_yielder
		each_item do |record|
			yielder(record) do |*a, **k|
				row_template(*a, **k)
				row_appender.call
			end
		end
	else
		@row_appender = row_appender
		each_item do |record|
			around_row(record)
		end
	end

	buffer
end

#content_type ⇒ Object 



134
135
136
 
# File 'lib/phlex/csv.rb', line 134

def content_type
	"text/csv"
end

#delimiter ⇒ Object 



138
139
140
 
# File 'lib/phlex/csv.rb', line 138

def delimiter
	","
end

#filename ⇒ Object 



130
131
132
 
# File 'lib/phlex/csv.rb', line 130

def filename
	nil
end