File: csv_builder_spec.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (208 lines) | stat: -rw-r--r-- 6,815 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# frozen_string_literal: true

RSpec.describe CsvBuilder do
  let(:csv_data) { subject.render }
  let(:header_to_value_hash) do
    { 'Q & A' => :question, 'Reversed' => ->(o) { o.question.to_s.reverse } }
  end

  let(:subject) do
    described_class.new(enumerable, header_to_value_hash)
  end

  shared_examples 'csv builder examples' do
    let(:items) { [object] }

    it 'has a version number' do
      expect(CsvBuilder::Version::VERSION).not_to be nil
    end

    it 'generates a csv' do
      expect(csv_data.scan(/(,|\n)/).join).to include ",\n,"
    end

    it 'uses a temporary file to reduce memory allocation' do
      expect(CSV).to receive(:new).with(instance_of(Tempfile)).and_call_original

      subject.render
    end

    it 'counts the number of rows' do
      subject.render

      expect(subject.rows_written).to eq 1
    end

    describe 'rows_expected' do
      it 'uses rows_written if CSV rendered successfully' do
        subject.render

        expect(enumerable).not_to receive(:count)
        expect(subject.rows_expected).to eq 1
      end

      it 'falls back to calling .count before rendering begins' do
        expect(subject.rows_expected).to eq 1
      end
    end

    it 'avoids loading all data in a single query' do
      expect(enumerable).to receive(:find_each)

      subject.render
    end

    it 'uses hash keys as headers' do
      expect(csv_data).to start_with 'Q & A'
    end

    it 'gets data by calling method provided as hash value' do
      expect(csv_data).to include 'answer'
    end

    it 'allows lambdas to look up more complicated data' do
      expect(csv_data).to include 'rewsna'
    end
  end

  shared_examples 'csv builder with truncation ability' do
    let(:items) { [big_object, big_object, big_object] }
    let(:row_size) { question_value.length * 2 }

    it 'occurs after given number of bytes' do
      expect(subject.render(row_size * 2).length).to be_between(row_size * 2, row_size * 3)
      expect(subject).to be_truncated
      expect(subject.rows_written).to eq 2
    end

    it 'is ignored by default' do
      expect(subject.render.length).to be > row_size * 3
      expect(subject.rows_written).to eq 3
    end

    it 'causes rows_expected to fall back to .count' do
      subject.render(0)

      expect(enumerable).to receive(:count).and_call_original
      expect(subject.rows_expected).to eq 3
    end
  end

  shared_examples 'excel sanitization' do
    let(:dangerous_title) { double(title: "=cmd|' /C calc'!A0 title", description: "*safe_desc") }
    let(:dangerous_desc) { double(title: "*safe_title", description: "=cmd|' /C calc'!A0 desc") }
    let(:header_to_value_hash) { { 'Title' => 'title', 'Description' => 'description' } }
    let(:items) { [dangerous_title, dangerous_desc] }

    it 'sanitizes dangerous characters at the beginning of a column' do
      expect(csv_data).to include "'=cmd|' /C calc'!A0 title"
      expect(csv_data).to include "'=cmd|' /C calc'!A0 desc"
    end

    it 'does not sanitize safe symbols at the beginning of a column' do
      expect(csv_data).not_to include "'*safe_desc"
      expect(csv_data).not_to include "'*safe_title"
    end

    context 'when dangerous characters are after a line break' do
      let(:items) { [double(title: "Safe title", description: "With task list\n-[x] todo 1")] }

      it 'does not append single quote to description' do
        expect(csv_data).to eq("Title,Description\nSafe title,\"With task list\n-[x] todo 1\"\n")
      end
    end
  end

  shared_examples 'builder that replaces newlines' do
    let(:object) { double(title: "title", description: "Line 1\n\nLine 2") }
    let(:header_to_value_hash) { { 'Title' => 'title', 'Description' => 'description' } }
    let(:items) { [object] }

    it 'does not replace newlines by default' do
      expect(csv_data).to eq("Title,Description\ntitle,\"Line 1\n\nLine 2\"\n")
    end

    context 'when replace_newlines is set to true' do
      let(:subject) { described_class.new(enumerable, header_to_value_hash, replace_newlines: true) }

      it 'replaces newlines with a literal "\n"' do
        expect(csv_data).to eq("Title,Description\ntitle,Line 1\\n\\nLine 2\n")
      end
    end

    context 'when line is nil' do
      let(:object) { double(title: "title", description: nil) }

      it 'gracefully generates CSV' do
        expect(csv_data).to eq("Title,Description\ntitle,\n")
      end
    end

    context 'when data is not a string' do
      let(:object) { double(title: "title", created_at: Date.new(2001, 2, 3)) }
      let(:header_to_value_hash) { { 'Title' => 'title', 'Created At' => 'created_at' } }

      it 'gracefully generates CSV' do
        expect(csv_data).to eq("Title,Created At\ntitle,2001-02-03\n")
      end
    end
  end

  context 'when ActiveRecord::Relation like object is given' do
    let(:object) { double(question: :answer) }
    let(:enumerable) { described_class::FakeRelation.new(items) }

    before do
      stub_const("#{described_class}::FakeRelation", Array)

      described_class::FakeRelation.class_eval do
        def find_each(&block)
          each(&block)
        end
      end
    end

    it_behaves_like 'csv builder examples'
    it_behaves_like 'excel sanitization'
    it_behaves_like 'builder that replaces newlines'
    it_behaves_like 'csv builder with truncation ability' do
      let(:big_object) { double(question: 'Long' * 1024) }
      let(:question_value) { big_object.question }
    end
  end

  context 'when Enumerable like object is given' do
    let(:object) { double(question: :answer) }
    let(:enumerable) { items }

    it_behaves_like 'csv builder examples'
    it_behaves_like 'excel sanitization'
    it_behaves_like 'builder that replaces newlines'
    it_behaves_like 'csv builder with truncation ability' do
      let(:big_object) { double(question: 'Long' * 1024) }
      let(:question_value) { big_object.question }
    end
  end

  context 'when Hash object is given' do
    let(:object) { { question: :answer } }
    let(:enumerable) { items }
    let(:header_to_value_hash) do
      { 'Q & A' => :question, 'Reversed' => ->(o) { o[:question].to_s.reverse } }
    end

    it_behaves_like 'csv builder examples'
    it_behaves_like 'builder that replaces newlines'

    it_behaves_like 'excel sanitization' do
      let(:dangerous_title) { { title: "=cmd|' /C calc'!A0 title", description: "*safe_desc" } }
      let(:dangerous_desc) { { title: "*safe_title", description: "=cmd|' /C calc'!A0 desc" } }
      let(:header_to_value_hash) { { 'Title' => :title, 'Description' => :description } }
    end

    it_behaves_like 'csv builder with truncation ability' do
      let(:big_object) { { question: 'Long' * 1024 } }
      let(:question_value) { big_object[:question] }
    end
  end
end