uncsv 0.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +6 -0
- data/.rspec +2 -0
- data/.rubocop.yml +21 -0
- data/.travis.yml +37 -0
- data/.yardopts +4 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +201 -0
- data/README.md +159 -0
- data/Rakefile +13 -0
- data/bin/check-version +6 -0
- data/bin/console +15 -0
- data/bin/rake +18 -0
- data/bin/rspec +18 -0
- data/bin/rubocop +18 -0
- data/bin/yard +18 -0
- data/bin/yardoc +18 -0
- data/bin/yri +18 -0
- data/lib/uncsv/config.rb +204 -0
- data/lib/uncsv/header.rb +173 -0
- data/lib/uncsv/key_normalizer.rb +61 -0
- data/lib/uncsv/row.rb +109 -0
- data/lib/uncsv/rows.rb +99 -0
- data/lib/uncsv/version.rb +6 -0
- data/lib/uncsv.rb +71 -0
- data/uncsv.gemspec +30 -0
- metadata +181 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 0ad035b69e4e56a72c50e9a3f32e71c32207b1d79c74d6ceda3858b8a0e2abef
|
4
|
+
data.tar.gz: 971142d6ccf58225b75c186eae8e4dd51ea751f4a1bb524bd94cd64b8799c78b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ae8ee0e471330f07b64a29a9cc767597ad6cec2ae124e396f1bbac3df1d105ec8f06158add34d04122a31800199604d5e6075934f118448fd30174e4179fb95b
|
7
|
+
data.tar.gz: f48b76c8ddab1f4407c0d86ef4b2ffa86e80d0090447aa0a2f1c1507b5703f20a86581cdf60ab8d4e6d676fc1cb27a3ac05d9ab44376c3f28511fce8d325a90d
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.rubocop.yml
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
---
|
2
|
+
AllCops:
|
3
|
+
TargetRubyVersion: 2.3
|
4
|
+
|
5
|
+
Layout/EndAlignment:
|
6
|
+
EnforcedStyleAlignWith: variable
|
7
|
+
|
8
|
+
Layout/AlignParameters:
|
9
|
+
EnforcedStyle: with_fixed_indentation
|
10
|
+
|
11
|
+
Layout/IndentArray:
|
12
|
+
EnforcedStyle: consistent
|
13
|
+
|
14
|
+
Layout/IndentHash:
|
15
|
+
EnforcedStyle: consistent
|
16
|
+
|
17
|
+
Layout/MultilineMethodCallIndentation:
|
18
|
+
EnforcedStyle: indented
|
19
|
+
|
20
|
+
Lint/MissingCopEnableDirective:
|
21
|
+
Enabled: false
|
data/.travis.yml
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
---
|
2
|
+
language: ruby
|
3
|
+
rvm:
|
4
|
+
- 2.3
|
5
|
+
- 2.4
|
6
|
+
- 2.5
|
7
|
+
env:
|
8
|
+
global:
|
9
|
+
- COVERAGE=1
|
10
|
+
- secure: 'ZVxUWgGa1tlRWTxT8zj8ca8ZTKMIZk7YTTM3BJTPev1y3PvGy4UXr+18Iwmzq0Vv329SvZNy1Y4bxE/UUgiH9ZaYlw/DlC/zpKr+um/Gmblu9jvdq44iUMJLhu4xA6q8EvHxKZ9NY9xzmu3BC2N1FTUN+g0OlqQJ1oGWRPmQa2hxc/eMdbgG2TqtH7WaTvD3mPV2iv7uWfLOB9ZQu9BFPy4spfasBmXRIkbJSGG8wG/z5JCdvpTTLCVvp3At/dy2NzjjDUjHF+Greweu7CYg5zXFsfBW/PGzJEoM9gIYCZxR90033KeAbaiATEI+b0SBC3kt2ej9nbJRpTRTf5Evonu0lgXnhpBrI7AZWqNPkSbYDJUL+gj8ZJv4cpWfHk2TcYB6VXPNoYV/md5a2zJbCl3E2mlnLEs9fhDF9ssnapi02++CcODmH4yBoD4aM8U37+F4XGglyn1I/0TiE8OT1GBnb7FJbc68+9+cgWqLs29M/V/tsb1ef3bE9YH5HqBzRz+6WUjIiOAiYQy5ZvLaH9ZmMpE2Ek5ut3PTdY+ghDToVkSPJ2wXLMriw0gjfQC9MWH21Qud92kmhim/OcmLJfnmcCmjOftmbDyWZDSriZHBx5ixe1FfOhL/2T9s3LqJGikznkubyJQ0rEB0u872+edzyFB8CX4X2Zozb0qcK9w='
|
11
|
+
|
12
|
+
before_script:
|
13
|
+
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
|
14
|
+
- chmod +x ./cc-test-reporter
|
15
|
+
- ./cc-test-reporter before-build
|
16
|
+
|
17
|
+
script:
|
18
|
+
- bin/rubocop
|
19
|
+
- bin/rspec --format doc
|
20
|
+
|
21
|
+
after_script:
|
22
|
+
- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
|
23
|
+
|
24
|
+
jobs:
|
25
|
+
include:
|
26
|
+
- stage: release
|
27
|
+
rvm: 2.3
|
28
|
+
script: skip
|
29
|
+
deploy:
|
30
|
+
provider: rubygems
|
31
|
+
api_key:
|
32
|
+
secure: 'tu+TzDHhiKVy5EeiMb8NVb/EHSflqhAhie6OFJc72nBBFAF9mow71sFpOzleQJ0gNdKnrWf17AQZLO9UQLIY2gP6fOHrLfDO5yLBMEpMjoqZISSBtugNUNCf8vg37QWbG6mAzMM67I/dMqT7U9KgL8CwaUwrs75W4KmIoaYqzkjiLc++k9j9dKpdbBBCEp0KNNbuAfEc9YWoas45LWFR1VfqB0CaGX4z8kWZai+N+8JLsmEO2bK6bPp2wtE+5ofXdkr5vSZK9Sp/7vLmh7P/D6ZDvuaF8KPt3wuPdtS1ZebuGWLsExcTTIgXzWBcYQ3hSHpvOwLWhI0M8ZpxmO3PPZO8+LsAzBijCj1HyOaXIrIybebuapvRixjWEV6mk3UXpBWgS3u0dslfbYa9hzbKCtAN/MTDSwLkdSuxsTuonNd406QQvX9O+yNT5+N8QpBqlAONeurSZhIRioiIyAwu6fL1CIJ5muDPaqG/V+dCh+z3W5KqnKgr9dY/bN8XizQoZhEFPg8WUjG2/ZRwtw3u5BD1rCbJIt3tAUSwhLLoSQFkH1f07evOuArOzaJjmehdaOiERkzsVmip65F/Bt+03NYShNzw3qK416ZjoxvVXpgb+mHVB8TEHL11bmvnrJ/v//fRp2W0ClHDZBmHvuem3UIXb7vnDDtvn8HClNHlgkg='
|
33
|
+
gem: uncsv
|
34
|
+
on:
|
35
|
+
tags: true
|
36
|
+
condition: bin/check-version
|
37
|
+
repo: machinima/uncsv
|
data/.yardopts
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright 2018 Warner Bros. Entertainment Inc.
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,159 @@
|
|
1
|
+
# Uncsv
|
2
|
+
|
3
|
+
[![Gem Version](https://badge.fury.io/rb/uncsv.svg)](https://badge.fury.io/rb/uncsv)
|
4
|
+
[![Build Status](https://travis-ci.org/machinima/uncsv.svg?branch=master)](https://travis-ci.org/machinima/uncsv)
|
5
|
+
[![Code Climate](https://codeclimate.com/github/machinima/uncsv/badges/gpa.svg)](https://codeclimate.com/github/machinima/uncsv)
|
6
|
+
[![Test Coverage](https://codeclimate.com/github/machinima/uncsv/badges/coverage.svg)](https://codeclimate.com/github/machinima/uncsv)
|
7
|
+
|
8
|
+
A parser for unruly CSVs
|
9
|
+
|
10
|
+
Parse CSVs with heirarchical headers and duplicated headers. Skip lines by line
|
11
|
+
number, etc.
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
Add this line to your application's Gemfile:
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
gem 'uncsv'
|
19
|
+
```
|
20
|
+
|
21
|
+
And then execute:
|
22
|
+
|
23
|
+
```sh
|
24
|
+
bundle
|
25
|
+
```
|
26
|
+
|
27
|
+
Or install it yourself as:
|
28
|
+
|
29
|
+
```sh
|
30
|
+
gem install uncsv
|
31
|
+
```
|
32
|
+
|
33
|
+
## Usage
|
34
|
+
|
35
|
+
Reading a CSV with Uncsv is similar to using Ruby's built-in CSV class. Create
|
36
|
+
a new instance of `Uncsv` and pass it a `String` or `IO`. The second argument
|
37
|
+
is an options hash, see below.
|
38
|
+
|
39
|
+
```ruby
|
40
|
+
require 'uncsv'
|
41
|
+
|
42
|
+
data = "A,B,C\n1,2,3"
|
43
|
+
csv = Uncsv.new(data, header_rows: 0)
|
44
|
+
csv.map do { |row| row['B'] }
|
45
|
+
```
|
46
|
+
|
47
|
+
### Opening a File
|
48
|
+
|
49
|
+
Uncsv can read directly from the filesystem with the `open` method.
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
Uncsv.open('my_data.csv')
|
53
|
+
```
|
54
|
+
|
55
|
+
### Enumerable Methods
|
56
|
+
|
57
|
+
Uncsv is an `Enumerable`. All enumerable methods like `each`, `map`, `reduce`,
|
58
|
+
etc. are supported.
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
data = "A,B,C\n1,2,3\n4,5,6"
|
62
|
+
csv = Uncsv.new(data, header_rows: 0)
|
63
|
+
c_total = csv.reduce do { |sum, row| sum + row['C'] }
|
64
|
+
```
|
65
|
+
|
66
|
+
### Options
|
67
|
+
|
68
|
+
The following options can be passed as a hash to the second argument of the
|
69
|
+
Uncsv constructor, or set inside the constructor block.
|
70
|
+
|
71
|
+
```ruby
|
72
|
+
Uncsv.new(data, skip_blanks: true)
|
73
|
+
|
74
|
+
# Is equivalent to
|
75
|
+
Uncsv.new(data) do |config|
|
76
|
+
config.skip_blanks = true
|
77
|
+
end
|
78
|
+
```
|
79
|
+
|
80
|
+
#### Uncsv Options
|
81
|
+
|
82
|
+
- `:expand_headers`: Default `false`. If set to `true`, blank header row cells
|
83
|
+
will assume the header of the row to their left. This is useful for
|
84
|
+
heirarchical headers where not all the header cells are filled in. If set to
|
85
|
+
an array of header indexes, only the specified headers will be expanded.
|
86
|
+
- `:header_rows`: Default `[]`. Can be set to either a single row index or an
|
87
|
+
array of row indexes. For example, it could be set to `0` to indicate a
|
88
|
+
header in the first row. If set to an array of indexes (`[1,2]`), the header
|
89
|
+
row text will be joined by the `:header_separator`. For example, if if the
|
90
|
+
cell (0,0) had the value `"Personal"` and cell (1,0) had the value "Name",
|
91
|
+
the header would become `"Personal.Name"`. Any data above the last header row
|
92
|
+
will be ignored.
|
93
|
+
- `:header_separator`: Default `"."`. When using multiple header rows, this is
|
94
|
+
a string used to separate the individual header fields.
|
95
|
+
- `:nil_empty`: Default `true`. If `true`, empty cells will be set to `nil`,
|
96
|
+
otherwise, they are set to an empty string.
|
97
|
+
- `:normalize_headers`: Default `false`. If set to `true`, header field text
|
98
|
+
will be normalized. The text will be lowercased, and non-alphanumeric
|
99
|
+
characters will be replaced with underscores (`_`). If set to a string,
|
100
|
+
those characters will be replaced with the string instead. If set to a hash,
|
101
|
+
the hash will be treated as options to KeyNormalizer, accepting the
|
102
|
+
`:separator`, and `:downcase` options. If set to another object, it is
|
103
|
+
expected to respond to the `normalize(key)` method by returning a normalized
|
104
|
+
string.
|
105
|
+
- `:skip_blanks`: Default `false`. If `true`, rows whose fields are all empty
|
106
|
+
will be skipped.
|
107
|
+
- `:skip_rows`: Default `[]`. If set to an array of row indexes, those rows
|
108
|
+
will be skipped. This option does not apply to header rows.
|
109
|
+
- `:unique_headers`: Default `false`. If set to `true`, headers will be forced
|
110
|
+
to be unique by appending numbers to duplicates. For example, if two header
|
111
|
+
cells have the text `"Name"`, the headers will become `"Name.0"`, and
|
112
|
+
`"Name.1"`. The separator between the text and the number can be set using
|
113
|
+
the `:header_separator` option.
|
114
|
+
|
115
|
+
#### Options from Std-lib CSV
|
116
|
+
|
117
|
+
See the documentation for Ruby's built-in `CSV` class for the following
|
118
|
+
options.
|
119
|
+
|
120
|
+
- `:col_sep`
|
121
|
+
- `:field_size_limit`
|
122
|
+
- `:quote_char`
|
123
|
+
- `:row_sep`
|
124
|
+
- `:skip_blanks`
|
125
|
+
|
126
|
+
## Development
|
127
|
+
|
128
|
+
After checking out the repo, run `bundle` to install dependencies. You
|
129
|
+
can also run `bin/console` for an interactive prompt that will allow you to
|
130
|
+
experiment.
|
131
|
+
|
132
|
+
To check your work, run `bin/rake` to check code style and run the tests. To
|
133
|
+
generate a code coverage report, set the `COVERAGE` environment variable when
|
134
|
+
running the tests.
|
135
|
+
|
136
|
+
```sh
|
137
|
+
COVERAGE=1 bin/rake
|
138
|
+
```
|
139
|
+
|
140
|
+
## Contributing
|
141
|
+
|
142
|
+
Bug reports and pull requests are welcome on GitHub at
|
143
|
+
https://github.com/machinima/uncsv.
|
144
|
+
|
145
|
+
## License
|
146
|
+
|
147
|
+
Copyright 2018 Warner Bros. Entertainment Inc.
|
148
|
+
|
149
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
150
|
+
you may not use this file except in compliance with the License.
|
151
|
+
You may obtain a copy of the License at
|
152
|
+
|
153
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
154
|
+
|
155
|
+
Unless required by applicable law or agreed to in writing, software
|
156
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
157
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
158
|
+
See the License for the specific language governing permissions and
|
159
|
+
limitations under the License.
|
data/Rakefile
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'bundler/gem_tasks'
|
4
|
+
require 'rspec/core/rake_task'
|
5
|
+
require 'rubocop/rake_task'
|
6
|
+
require 'yard'
|
7
|
+
|
8
|
+
RSpec::Core::RakeTask.new(:spec)
|
9
|
+
RuboCop::RakeTask.new
|
10
|
+
YARD::Rake::YardocTask.new
|
11
|
+
|
12
|
+
task default: :check
|
13
|
+
task check: %i[rubocop spec]
|
data/bin/check-version
ADDED
data/bin/console
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require 'bundler/setup'
|
5
|
+
require 'uncsv'
|
6
|
+
|
7
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
8
|
+
# with your gem easier. You can also use a different console, if you like.
|
9
|
+
|
10
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
11
|
+
# require "pry"
|
12
|
+
# Pry.start
|
13
|
+
|
14
|
+
require 'irb'
|
15
|
+
IRB.start
|
data/bin/rake
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
#
|
5
|
+
# This file was generated by Bundler.
|
6
|
+
#
|
7
|
+
# The application 'rake' is installed as part of a gem, and
|
8
|
+
# this file is here to facilitate running it.
|
9
|
+
#
|
10
|
+
|
11
|
+
require 'pathname'
|
12
|
+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
|
13
|
+
Pathname.new(__FILE__).realpath)
|
14
|
+
|
15
|
+
require 'rubygems'
|
16
|
+
require 'bundler/setup'
|
17
|
+
|
18
|
+
load Gem.bin_path('rake', 'rake')
|
data/bin/rspec
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
#
|
5
|
+
# This file was generated by Bundler.
|
6
|
+
#
|
7
|
+
# The application 'rspec' is installed as part of a gem, and
|
8
|
+
# this file is here to facilitate running it.
|
9
|
+
#
|
10
|
+
|
11
|
+
require 'pathname'
|
12
|
+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
|
13
|
+
Pathname.new(__FILE__).realpath)
|
14
|
+
|
15
|
+
require 'rubygems'
|
16
|
+
require 'bundler/setup'
|
17
|
+
|
18
|
+
load Gem.bin_path('rspec-core', 'rspec')
|
data/bin/rubocop
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
#
|
5
|
+
# This file was generated by Bundler.
|
6
|
+
#
|
7
|
+
# The application 'rubocop' is installed as part of a gem, and
|
8
|
+
# this file is here to facilitate running it.
|
9
|
+
#
|
10
|
+
|
11
|
+
require 'pathname'
|
12
|
+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
|
13
|
+
Pathname.new(__FILE__).realpath)
|
14
|
+
|
15
|
+
require 'rubygems'
|
16
|
+
require 'bundler/setup'
|
17
|
+
|
18
|
+
load Gem.bin_path('rubocop', 'rubocop')
|
data/bin/yard
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
#
|
5
|
+
# This file was generated by Bundler.
|
6
|
+
#
|
7
|
+
# The application 'yard' is installed as part of a gem, and
|
8
|
+
# this file is here to facilitate running it.
|
9
|
+
#
|
10
|
+
|
11
|
+
require 'pathname'
|
12
|
+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
|
13
|
+
Pathname.new(__FILE__).realpath)
|
14
|
+
|
15
|
+
require 'rubygems'
|
16
|
+
require 'bundler/setup'
|
17
|
+
|
18
|
+
load Gem.bin_path('yard', 'yard')
|
data/bin/yardoc
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
#
|
5
|
+
# This file was generated by Bundler.
|
6
|
+
#
|
7
|
+
# The application 'yardoc' is installed as part of a gem, and
|
8
|
+
# this file is here to facilitate running it.
|
9
|
+
#
|
10
|
+
|
11
|
+
require 'pathname'
|
12
|
+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
|
13
|
+
Pathname.new(__FILE__).realpath)
|
14
|
+
|
15
|
+
require 'rubygems'
|
16
|
+
require 'bundler/setup'
|
17
|
+
|
18
|
+
load Gem.bin_path('yard', 'yardoc')
|
data/bin/yri
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
#
|
5
|
+
# This file was generated by Bundler.
|
6
|
+
#
|
7
|
+
# The application 'yri' is installed as part of a gem, and
|
8
|
+
# this file is here to facilitate running it.
|
9
|
+
#
|
10
|
+
|
11
|
+
require 'pathname'
|
12
|
+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
|
13
|
+
Pathname.new(__FILE__).realpath)
|
14
|
+
|
15
|
+
require 'rubygems'
|
16
|
+
require 'bundler/setup'
|
17
|
+
|
18
|
+
load Gem.bin_path('yard', 'yri')
|