├── .github ├── FUNDING.yml └── workflows │ ├── codeql-analysis.yml │ └── go.yml ├── .gitignore ├── LICENCE.md ├── README.md ├── csv_files ├── badFloat.csv ├── badFormat.csv ├── badHeader.csv ├── badInt.csv ├── bool.csv ├── empty.csv ├── float32.csv ├── noHeader.csv ├── semicolon.csv ├── trailingSpaces.csv ├── valid.csv └── valid_bom.csv ├── csvtag.go ├── csvtag_test.go ├── dump.go ├── dump_test.go ├── go.mod ├── load.go └── load_test.go /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | liberapay: artonge 2 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | name: "Code scanning - action" 2 | 3 | on: 4 | push: 5 | pull_request: 6 | schedule: 7 | - cron: '0 1 * * 1' 8 | 9 | jobs: 10 | CodeQL-Build: 11 | 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - name: Checkout repository 16 | uses: actions/checkout@v2 17 | with: 18 | # We must fetch at least the immediate parents so that if this is 19 | # a pull request then we can checkout the head. 20 | fetch-depth: 2 21 | 22 | # If this run was triggered by a pull request event, then checkout 23 | # the head of the pull request instead of the merge commit. 24 | - run: git checkout HEAD^2 25 | if: ${{ github.event_name == 'pull_request' }} 26 | 27 | # Initializes the CodeQL tools for scanning. 28 | - name: Initialize CodeQL 29 | uses: github/codeql-action/init@v1 30 | # Override language selection by uncommenting this and choosing your languages 31 | # with: 32 | # languages: go, javascript, csharp, python, cpp, java 33 | 34 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 35 | # If this step fails, then you should remove it and run the build manually (see below) 36 | - name: Autobuild 37 | uses: github/codeql-action/autobuild@v1 38 | 39 | # ℹ️ Command-line programs to run using the OS shell. 40 | # 📚 https://git.io/JvXDl 41 | 42 | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines 43 | # and modify them (or add more) to build your code if your project 44 | # uses a compiled language 45 | 46 | #- run: | 47 | # make bootstrap 48 | # make release 49 | 50 | - name: Perform CodeQL Analysis 51 | uses: github/codeql-action/analyze@v1 52 | -------------------------------------------------------------------------------- /.github/workflows/go.yml: -------------------------------------------------------------------------------- 1 | name: Go 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | 11 | build: 12 | name: Build 13 | runs-on: ubuntu-latest 14 | steps: 15 | 16 | - name: Set up Go 1.x 17 | uses: actions/setup-go@v2 18 | with: 19 | go-version: ^1.13 20 | id: go 21 | 22 | - name: Check out code into the Go module directory 23 | uses: actions/checkout@v2 24 | 25 | - name: Get dependencies 26 | run: | 27 | go get -v -t -d ./... 28 | if [ -f Gopkg.toml ]; then 29 | curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh 30 | dep ensure 31 | fi 32 | 33 | - name: Build 34 | run: go build -v . 35 | 36 | - name: Test 37 | run: go test -v . 38 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.dll 4 | *.so 5 | *.dylib 6 | 7 | # Test binary, build with `go test -c` 8 | *.test 9 | 10 | # Output of the go coverage tool, specifically when used with LiteIDE 11 | *.out 12 | 13 | # Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 14 | .glide/ 15 | 16 | csv_files/csv_file_name.csv 17 | -------------------------------------------------------------------------------- /LICENCE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # go-csv-tag 2 | 3 | Read csv file from Go using tags 4 | 5 | [![godoc for artonge/go-csv-tag](https://godoc.org/github.com/artonge/go-csv-tag?status.svg)](http://godoc.org/github.com/artonge/go-csv-tag) 6 | 7 | ![Go](https://github.com/artonge/go-csv-tag/workflows/Go/badge.svg) 8 | [![goreportcard for artonge/go-csv-tag](https://goreportcard.com/badge/github.com/artonge/go-csv-tag)](https://goreportcard.com/report/artonge/go-csv-tag) 9 | 10 | [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) 11 | 12 | **The project is in maintenance mode.** 13 | 14 | It is kept compatible with changes in the Go ecosystem but no new features will be developed. PR could be accepted. 15 | 16 | # Install 17 | 18 | `go get github.com/artonge/go-csv-tag/v2` 19 | 20 | # Example 21 | 22 | ## Load 23 | 24 | The csv file: 25 | 26 | ```csv 27 | name, ID, number 28 | name1, 1, 1.2 29 | name2, 2, 2.3 30 | name3, 3, 3.4 31 | ``` 32 | 33 | Your Go code: 34 | 35 | ```go 36 | type Demo struct { // A structure with tags 37 | Name string `csv:"name"` 38 | ID int `csv:"ID"` 39 | Num float64 `csv:"number"` 40 | } 41 | 42 | tab := []Demo{} // Create the slice where to put the content 43 | err := csvtag.LoadFromPath( 44 | "file.csv", // Path of the csv file 45 | &tab, // A pointer to the create slice 46 | csvtag.CsvOptions{ // Load your csv with optional options 47 | Separator: ';', // changes the values separator, default to ',' 48 | Header: []string{"name", "ID", "number"}, // specify custom headers 49 | TagKey: "csv", // specify a custom tag key, default to 'csv' 50 | }) 51 | ``` 52 | 53 | You can also load the data from an io.Reader with: 54 | 55 | ```go 56 | csvtag.LoadFromReader(youReader, &tab) 57 | ``` 58 | 59 | Or from a string with: 60 | 61 | ```go 62 | csvtag.LoadFromString(yourString, &tab) 63 | ``` 64 | 65 | ## Dump 66 | 67 | Your Go code: 68 | 69 | ```go 70 | type Demo struct { // A structure with tags 71 | Name string `csv:"name"` 72 | ID int `csv:"ID"` 73 | Num float64 `csv:"number"` 74 | } 75 | 76 | tab := []Demo{ // Create the slice where to put the content 77 | Demo{ 78 | Name: "some name", 79 | ID: 1, 80 | Num: 42.5, 81 | }, 82 | } 83 | 84 | err := csvtag.DumpToFile(tab, "csv_file_name.csv") 85 | ``` 86 | 87 | You can also dump the data into an io.Writer with: 88 | 89 | ```go 90 | err := csvtag.DumpToWriter(tab, yourIOWriter) 91 | ``` 92 | 93 | Or dump to a string with: 94 | 95 | ```go 96 | str, err := csvtag.DumpToString(tab) 97 | ``` 98 | 99 | The csv file written: 100 | 101 | ```csv 102 | name,ID,number 103 | some name,1,42.5 104 | ``` 105 | -------------------------------------------------------------------------------- /csv_files/badFloat.csv: -------------------------------------------------------------------------------- 1 | header1, header2, header3 2 | line1, 1, 1.a 3 | line2, 2, 2.3 4 | line3, 3, 3.4 5 | -------------------------------------------------------------------------------- /csv_files/badFormat.csv: -------------------------------------------------------------------------------- 1 | header1, header2, header4 2 | l11, l12, l13, l14 3 | l21, l22, l23, l24 4 | l31, l32, l33, l34 5 | -------------------------------------------------------------------------------- /csv_files/badHeader.csv: -------------------------------------------------------------------------------- 1 | header1, header2, header3 2 | line1, 1, 1.2 3 | line2, 2, 2.3 4 | line3, 3, 3.4 5 | -------------------------------------------------------------------------------- /csv_files/badInt.csv: -------------------------------------------------------------------------------- 1 | header1, header2, header3 2 | line1, 1.2, 1.2 3 | line2, 2, 2.3 4 | line3, 3, 3.4 5 | -------------------------------------------------------------------------------- /csv_files/bool.csv: -------------------------------------------------------------------------------- 1 | header1, header2 2 | line1, true 3 | line2, false 4 | line3, 5 | -------------------------------------------------------------------------------- /csv_files/empty.csv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/artonge/go-csv-tag/2f2b4b60719d8dcff3bac2a48f4bfd3499873423/csv_files/empty.csv -------------------------------------------------------------------------------- /csv_files/float32.csv: -------------------------------------------------------------------------------- 1 | header1, header2 2 | line1, 1.2 3 | line2, 2.3 4 | -------------------------------------------------------------------------------- /csv_files/noHeader.csv: -------------------------------------------------------------------------------- 1 | line1, 1, 1.2 2 | line2, 2, 2.3 3 | line3, 3, 3.4 4 | -------------------------------------------------------------------------------- /csv_files/semicolon.csv: -------------------------------------------------------------------------------- 1 | header1; header2; header3 2 | line1; 1; 1.2 3 | line2; 2; 2.3 4 | line3; 3; 3.4 5 | -------------------------------------------------------------------------------- /csv_files/trailingSpaces.csv: -------------------------------------------------------------------------------- 1 | header1, header2, header3 2 | line1, 1, 1.2 3 | line2, 2, 2.3 4 | line3, 3, 3.4 5 | -------------------------------------------------------------------------------- /csv_files/valid.csv: -------------------------------------------------------------------------------- 1 | header1, header2, header3 2 | line1, 1, 1.2 3 | line2, 2, 2.3 4 | line3, 3, 3.4 5 | -------------------------------------------------------------------------------- /csv_files/valid_bom.csv: -------------------------------------------------------------------------------- 1 | header1, header2, header3 2 | line1, 1, 1.2 3 | line2, 2, 2.3 4 | line3, 3, 3.4 5 | -------------------------------------------------------------------------------- /csvtag.go: -------------------------------------------------------------------------------- 1 | package csvtag 2 | 3 | // CsvOptions - options when loading or dumping csv. 4 | type CsvOptions struct { 5 | Separator rune 6 | UseCRLF bool // True to use \r\n as the line terminator 7 | Header []string 8 | TagKey string 9 | } 10 | 11 | const DefaultTagKey string = "csv" 12 | -------------------------------------------------------------------------------- /csvtag_test.go: -------------------------------------------------------------------------------- 1 | package csvtag 2 | 3 | import ( 4 | "fmt" 5 | "testing" 6 | ) 7 | 8 | func TestDumpAndLoad(t *testing.T) { 9 | str, err := DumpToString(tabTest) 10 | if err != nil { 11 | fmt.Println(err) 12 | t.Fail() 13 | } 14 | 15 | tabT := []test{} 16 | err = LoadFromString(str, &tabT) 17 | if err != nil { 18 | fmt.Println(err) 19 | t.Fail() 20 | } 21 | 22 | if tabT[0].ID != tabTest[0].ID || 23 | tabT[0].Name != tabTest[0].Name || 24 | tabT[0].Num != tabTest[0].Num { 25 | t.Fail() 26 | } 27 | } 28 | 29 | func TestDumpAndLoadTagKey(t *testing.T) { 30 | str, err := DumpToString(tabTestTagKey, CsvOptions{TagKey: "json"}) 31 | if err != nil { 32 | fmt.Println(err) 33 | t.Fail() 34 | } 35 | 36 | tabT := []testTagKey{} 37 | err = LoadFromString(str, &tabT, CsvOptions{TagKey: "json"}) 38 | if err != nil { 39 | fmt.Println(err) 40 | t.Fail() 41 | } 42 | 43 | if tabT[0].ID != tabTestTagKey[0].ID || 44 | tabT[0].Name != tabTestTagKey[0].Name || 45 | tabT[0].Num != tabTestTagKey[0].Num { 46 | t.Fail() 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /dump.go: -------------------------------------------------------------------------------- 1 | package csvtag 2 | 3 | import ( 4 | "bytes" 5 | "encoding/csv" 6 | "errors" 7 | "fmt" 8 | "io" 9 | "os" 10 | "reflect" 11 | "strconv" 12 | ) 13 | 14 | // DumpToWriter - writes a slice content into an io.Writer. 15 | // @param slice: an object typically of the form []struct, where the struct is using csv tags. 16 | // @param writer: the location of where you will write the slice content to. Example: File, Stdout, etc. 17 | // @param options (optional): options for the csv parsing. 18 | // @return an error if one occures. 19 | func DumpToWriter(slice interface{}, writer io.Writer, options ...CsvOptions) error { 20 | // If slice is a pointer, get the value it points to. 21 | // (if it isn't, Indirect() does nothing and returns the value it was called with). 22 | reflectedValue := reflect.Indirect(reflect.ValueOf(slice)) 23 | 24 | if reflectedValue.Kind() != reflect.Array && reflectedValue.Kind() != reflect.Slice { 25 | return errors.New("slice is not a slice") 26 | } 27 | 28 | option := CsvOptions{} 29 | if len(options) == 1 { 30 | option = options[0] 31 | } 32 | 33 | if option.TagKey == "" { 34 | option.TagKey = DefaultTagKey 35 | } 36 | 37 | // Generate the header. 38 | if option.Header == nil { 39 | for i := 0; i < reflectedValue.Type().Elem().NumField(); i++ { 40 | name := reflectedValue.Type().Elem().Field(i).Tag.Get(option.TagKey) 41 | if name != "" { 42 | option.Header = append(option.Header, name) 43 | } 44 | } 45 | } 46 | 47 | csvWriter := csv.NewWriter(writer) 48 | defer csvWriter.Flush() 49 | 50 | if option.Separator != 0 { 51 | csvWriter.Comma = option.Separator 52 | } 53 | 54 | csvWriter.UseCRLF = option.UseCRLF 55 | 56 | err := csvWriter.Write(option.Header) 57 | if err != nil { 58 | return err 59 | } 60 | 61 | for i := 0; i < reflectedValue.Len(); i++ { 62 | line := []string{} 63 | 64 | for j := 0; j < reflectedValue.Type().Elem().NumField(); j++ { 65 | valueRv := reflectedValue.Index(i) 66 | value := valueRv.Field(j) 67 | tag := valueRv.Type().Field(j).Tag.Get(option.TagKey) 68 | 69 | if tag == "" { 70 | continue 71 | } 72 | 73 | switch valueRv.Type().Field(j).Type.Kind() { 74 | case reflect.Float64, reflect.Float32: 75 | line = append(line, strconv.FormatFloat(value.Float(), 'f', -1, 64)) 76 | default: 77 | line = append(line, fmt.Sprint(value)) 78 | } 79 | } 80 | 81 | err = csvWriter.Write(line) 82 | if err != nil { 83 | return err 84 | } 85 | } 86 | 87 | return nil 88 | } 89 | 90 | // DumpToFile - writes a slice content into a file specified by path. 91 | // @param slice: An object typically of the form []struct, where the struct is using csv tag. 92 | // @param path: The file path string of where you want the file to be created. 93 | // @param options (optional): options for the csv parsing. 94 | // @return an error if one occures. 95 | func DumpToFile(slice interface{}, path string, options ...CsvOptions) error { 96 | file, err := os.Create(path) 97 | if err != nil { 98 | return err 99 | } 100 | 101 | err = DumpToWriter(slice, file, options...) 102 | 103 | file.Close() 104 | 105 | return err 106 | } 107 | 108 | // DumpToString - writes a slice content into a string. 109 | // @param slice: An object typically of the form []struct, where the struct is using csv tag. 110 | // @param options (optional): options for the csv parsing. 111 | // @return a string and an error if one occures. 112 | func DumpToString(slice interface{}, options ...CsvOptions) (string, error) { 113 | 114 | writer := new(bytes.Buffer) 115 | 116 | err := DumpToWriter(slice, writer, options...) 117 | if err != nil { 118 | return "", err 119 | } 120 | 121 | return writer.String(), nil 122 | } 123 | -------------------------------------------------------------------------------- /dump_test.go: -------------------------------------------------------------------------------- 1 | package csvtag 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "testing" 7 | ) 8 | 9 | var tabTest = []test{ 10 | {"name", 1, 0.000001}, 11 | } 12 | 13 | var tabTestTagKey = []testTagKey{ 14 | {"name", 1, 0.000001}, 15 | } 16 | 17 | var tabTestNoID = []testNoID{ 18 | {"name", 1, 0.000001}, 19 | } 20 | 21 | func TestDumpToFileEmptyName(t *testing.T) { 22 | err := DumpToFile(tabTest, "") 23 | if err == nil { 24 | t.Fail() 25 | } 26 | } 27 | 28 | func TestDumpTestStruct(t *testing.T) { 29 | buffer := bytes.Buffer{} 30 | 31 | err := DumpToWriter(tabTest, &buffer) 32 | if err != nil { 33 | fmt.Println(err) 34 | t.Fail() 35 | } 36 | 37 | if buffer.String() != "header1,header2,header3\nname,1,0.000001\n" { 38 | fmt.Println(buffer.String()) 39 | t.Fail() 40 | } 41 | } 42 | 43 | func TestDumpTestNoIdStruct(t *testing.T) { 44 | buffer := bytes.Buffer{} 45 | 46 | err := DumpToWriter(tabTestNoID, &buffer) 47 | if err != nil { 48 | t.Fail() 49 | } 50 | 51 | if buffer.String() != "header1,header\nname,0.000001\n" { 52 | fmt.Println(buffer.String()) 53 | t.Fail() 54 | } 55 | } 56 | 57 | func TestDumpTestStructPointer(t *testing.T) { 58 | buffer := bytes.Buffer{} 59 | 60 | err := DumpToWriter(&tabTest, &buffer) 61 | if err != nil { 62 | fmt.Println(err) 63 | t.Fail() 64 | } 65 | 66 | if buffer.String() != "header1,header2,header3\nname,1,0.000001\n" { 67 | fmt.Println(buffer.String()) 68 | t.Fail() 69 | } 70 | } 71 | 72 | func TestDumpTestNoIdStructPointer(t *testing.T) { 73 | buffer := bytes.Buffer{} 74 | 75 | err := DumpToWriter(&tabTestNoID, &buffer) 76 | if err != nil { 77 | t.Fail() 78 | } 79 | 80 | if buffer.String() != "header1,header\nname,0.000001\n" { 81 | fmt.Println(buffer.String()) 82 | t.Fail() 83 | } 84 | } 85 | 86 | func TestDumpNilPointer(t *testing.T) { 87 | buffer := bytes.Buffer{} 88 | 89 | var n *test 90 | err := DumpToWriter(n, &buffer) 91 | if err == nil { 92 | t.Fail() 93 | } 94 | } 95 | 96 | func TestEmptyDumpToWriter(t *testing.T) { 97 | buffer := bytes.Buffer{} 98 | 99 | err := DumpToWriter([]test{}, &buffer) 100 | if err != nil { 101 | t.Fail() 102 | } 103 | 104 | if buffer.String() != "header1,header2,header3\n" { 105 | fmt.Println(buffer.String()) 106 | t.Fail() 107 | } 108 | } 109 | 110 | func TestWrongType(t *testing.T) { 111 | buffer := bytes.Buffer{} 112 | err := DumpToWriter(2, &buffer) 113 | if err == nil { 114 | t.Fail() 115 | } 116 | } 117 | 118 | func TestBigFloat(t *testing.T) { 119 | buffer := bytes.Buffer{} 120 | err := DumpToWriter(2, &buffer) 121 | if err == nil { 122 | t.Fail() 123 | } 124 | } 125 | 126 | type Demo struct { // A structure with tags 127 | Name string `csv:"name"` 128 | ID int `csv:"ID"` 129 | Num float64 `csv:"number"` 130 | } 131 | 132 | func TestREADMEExample(t *testing.T) { 133 | 134 | tab := []Demo{ // Create the slice where to put the file content 135 | { 136 | Name: "some name", 137 | ID: 1, 138 | Num: 0.000001, 139 | }, 140 | } 141 | 142 | err := DumpToFile(tab, "csv_files/csv_file_name.csv") 143 | 144 | if err != nil { 145 | t.Fail() 146 | } 147 | } 148 | 149 | func TestDumpWithSemicolon(t *testing.T) { 150 | buffer := bytes.Buffer{} 151 | 152 | err := DumpToWriter(tabTest, &buffer, CsvOptions{Separator: ';'}) 153 | if err != nil { 154 | fmt.Println(err) 155 | t.Fail() 156 | } 157 | 158 | if buffer.String() != "header1;header2;header3\nname;1;0.000001\n" { 159 | fmt.Println(buffer.String()) 160 | t.Fail() 161 | } 162 | 163 | } 164 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/artonge/go-csv-tag/v2 2 | 3 | go 1.12 4 | -------------------------------------------------------------------------------- /load.go: -------------------------------------------------------------------------------- 1 | package csvtag 2 | 3 | import ( 4 | "bytes" 5 | "encoding/csv" 6 | "fmt" 7 | "io" 8 | "os" 9 | "reflect" 10 | "strconv" 11 | "strings" 12 | ) 13 | 14 | // LoadFromReader - Load csv from an io.Reader and put it in a array of the destination's type using tags. 15 | // Example: 16 | // 17 | // tabOfMyStruct := []MyStruct{} 18 | // err := Load( 19 | // myIoReader, 20 | // &tabOfMyStruct, 21 | // CsvOptions{ 22 | // Separator: ';', 23 | // Header: []string{"header1", "header2", "header3" 24 | // } 25 | // }) 26 | // 27 | // @param file: the io.Reader. 28 | // @param destination: object where to store the result. 29 | // @param options (optional): options for the csv parsing. 30 | // @return an error if one occurs. 31 | func LoadFromReader(file io.Reader, destination interface{}, options ...CsvOptions) error { 32 | if len(options) > 1 { 33 | return fmt.Errorf("error you can only pass one CsvOptions argument") 34 | } 35 | 36 | option := CsvOptions{} 37 | if len(options) == 1 { 38 | option = options[0] 39 | } 40 | 41 | if option.TagKey == "" { 42 | option.TagKey = DefaultTagKey 43 | } 44 | 45 | header, content, err := readFile(file, option.Separator, option.Header) 46 | if err != nil { 47 | return fmt.Errorf("error reading csv from io.Reader: %v", err) 48 | } 49 | 50 | // This means that the file is empty, so just return nil. 51 | if content == nil { 52 | return nil 53 | } 54 | 55 | err = mapToDestination(header, content, destination, option.TagKey) 56 | if err != nil { 57 | return fmt.Errorf("error mapping the content to the destination\n ==> %v", err) 58 | } 59 | 60 | return nil 61 | } 62 | 63 | // LoadFromPath - Load csv from a path and put it in a array of the destination's type using tags. 64 | // Example: 65 | // 66 | // tabOfMyStruct := []MyStruct{} 67 | // err := Load( 68 | // "my_csv_file.csv", 69 | // &tabOfMyStruct, 70 | // CsvOptions{ 71 | // Separator: ';', 72 | // Header: []string{"header1", "header2", "header3" 73 | // } 74 | // }) 75 | // 76 | // @param path: the path of the csv file. 77 | // @param destination: object where to store the result. 78 | // @param options (optional): options for the csv parsing. 79 | // @return an error if one occurs. 80 | func LoadFromPath(path string, destination interface{}, options ...CsvOptions) error { 81 | file, err := os.Open(path) 82 | defer file.Close() 83 | if err != nil { 84 | return err 85 | } 86 | 87 | err = LoadFromReader(file, destination, options...) 88 | if err != nil { 89 | return fmt.Errorf("error mapping csv from path %v:\n ==> %v", path, err) 90 | } 91 | 92 | return nil 93 | } 94 | 95 | // LoadFromString - Load csv from string and put it in a array of the destination's type using tags. 96 | // Example: 97 | // 98 | // tabOfMyStruct := []MyStruct{} 99 | // err := Load( 100 | // myString, 101 | // &tabOfMyStruct, 102 | // CsvOptions{ 103 | // Separator: ';', 104 | // Header: []string{"header1", "header2", "header3" 105 | // } 106 | // }) 107 | // 108 | // @param str: the string. 109 | // @param destination: object where to store the result. 110 | // @param options (optional): options for the csv parsing. 111 | // @return an error if one occurs. 112 | func LoadFromString(str string, destination interface{}, options ...CsvOptions) error { 113 | return LoadFromReader(strings.NewReader(str), destination, options...) 114 | } 115 | 116 | // Load the header and file content in memory. 117 | // @param file: the io.Reader to read from. 118 | // @param separator: the separator used in the csv file. 119 | // @param header: the optional header if the file does not contain one. 120 | func readFile(file io.Reader, separator rune, header []string) ([]string, [][]string, error) { 121 | file = skipBOM(file) 122 | 123 | // Create and configure the csv reader. 124 | reader := csv.NewReader(file) 125 | reader.TrimLeadingSpace = true 126 | 127 | if separator != 0 { 128 | reader.Comma = separator 129 | } 130 | 131 | // We need to read it all at once to have the number of records for the array creation. 132 | content, err := reader.ReadAll() 133 | if err != nil { 134 | return nil, nil, err 135 | } 136 | 137 | // If file is empty, return. 138 | if len(content) == 0 { 139 | return nil, nil, nil 140 | } 141 | 142 | // If no header is provided, treat first line as the header. 143 | if header == nil { 144 | header = content[0] 145 | content = content[1:] 146 | } 147 | 148 | return header, content, nil 149 | } 150 | 151 | // Skip the Byte Order Mark (BOM) if it exists. 152 | // @param file: the io.Reader to read from. 153 | func skipBOM(file io.Reader) io.Reader { 154 | // Read the first 3 bytes. 155 | bom := make([]byte, 3) 156 | _, err := file.Read(bom) 157 | if err != nil { 158 | return file 159 | } 160 | 161 | // If the first 3 bytes are not the BOM, reset the reader. 162 | if bom[0] != 0xEF || bom[1] != 0xBB || bom[2] != 0xBF { 163 | return io.MultiReader(bytes.NewReader(bom), file) 164 | } 165 | 166 | return file 167 | } 168 | 169 | // Map the provided content to the destination using the header and the tags. 170 | // @param header: the csv header to match with the struct's tags. 171 | // @param content: the content to put in destination. 172 | // @param destination: the destination where to put the file's content. 173 | func mapToDestination(header []string, content [][]string, destination interface{}, tagKey string) error { 174 | if destination == nil { 175 | return fmt.Errorf("destination slice is nil") 176 | } 177 | 178 | if reflect.TypeOf(destination).Elem().Kind() != reflect.Slice { 179 | return fmt.Errorf("destination is not a slice") 180 | } 181 | 182 | // Map each header name to its index. 183 | headerMap := make(map[string]int) 184 | for i, name := range header { 185 | headerMap[strings.TrimSpace(name)] = i 186 | } 187 | 188 | // Create the slice to put the values in. 189 | sliceRv := reflect.MakeSlice( 190 | reflect.ValueOf(destination).Elem().Type(), 191 | len(content), 192 | len(content), 193 | ) 194 | 195 | for i, line := range content { 196 | emptyStruct := sliceRv.Index(i) 197 | 198 | for j := 0; j < emptyStruct.NumField(); j++ { 199 | propertyTag := emptyStruct.Type().Field(j).Tag.Get(tagKey) 200 | if propertyTag == "" { 201 | continue 202 | } 203 | 204 | propertyPosition, ok := headerMap[propertyTag] 205 | if !ok { 206 | continue 207 | } 208 | 209 | err := storeValue(line[propertyPosition], emptyStruct.Field(j)) 210 | if err != nil { 211 | return fmt.Errorf("line: %v to slice: %v:\n ==> %v", line, emptyStruct, err) 212 | } 213 | } 214 | } 215 | 216 | reflect.ValueOf(destination).Elem().Set(sliceRv) 217 | 218 | return nil 219 | } 220 | 221 | // Set the value of the valRv to rawValue. 222 | // @param rawValue: the value, as a string, that we want to store. 223 | // @param valRv: the reflected value where we want to store our value. 224 | // @return an error if one occurs. 225 | func storeValue(rawValue string, valRv reflect.Value) error { 226 | rawValue = strings.TrimSpace(rawValue) 227 | switch valRv.Kind() { 228 | case reflect.String: 229 | valRv.SetString(rawValue) 230 | case reflect.Uint32: 231 | fallthrough 232 | case reflect.Uint64: 233 | fallthrough 234 | case reflect.Uint: 235 | value, err := strconv.ParseUint(rawValue, 10, 64) 236 | if err != nil && rawValue != "" { 237 | return fmt.Errorf("error parsing uint '%v':\n ==> %v", rawValue, err) 238 | } 239 | valRv.SetUint(value) 240 | case reflect.Int32: 241 | fallthrough 242 | case reflect.Int64: 243 | fallthrough 244 | case reflect.Int: 245 | value, err := strconv.ParseInt(rawValue, 10, 64) 246 | if err != nil && rawValue != "" { 247 | return fmt.Errorf("error parsing int '%v':\n ==> %v", rawValue, err) 248 | } 249 | valRv.SetInt(value) 250 | case reflect.Float32: 251 | fallthrough 252 | case reflect.Float64: 253 | value, err := strconv.ParseFloat(rawValue, 64) 254 | if err != nil && rawValue != "" { 255 | return fmt.Errorf("error parsing float '%v':\n ==> %v", rawValue, err) 256 | } 257 | valRv.SetFloat(value) 258 | case reflect.Bool: 259 | value, err := strconv.ParseBool(rawValue) 260 | if err != nil && rawValue != "" { 261 | return fmt.Errorf("error parsing bool '%v':\n ==> %v", rawValue, err) 262 | } 263 | valRv.SetBool(value) 264 | } 265 | 266 | return nil 267 | } 268 | -------------------------------------------------------------------------------- /load_test.go: -------------------------------------------------------------------------------- 1 | package csvtag 2 | 3 | import ( 4 | "testing" 5 | ) 6 | 7 | type test struct { 8 | Name string `csv:"header1"` 9 | ID int `csv:"header2"` 10 | Num float64 `csv:"header3"` 11 | } 12 | 13 | type testTagKey struct { 14 | Name string `json:"header1"` 15 | ID int `json:"header2"` 16 | Num float64 `json:"header3"` 17 | } 18 | 19 | type testNoID struct { 20 | Name string `csv:"header1"` 21 | ID int 22 | Num float64 `csv:"header"` 23 | } 24 | 25 | type testBool struct { 26 | Name string `csv:"header1"` 27 | ABool bool `csv:"header2"` 28 | } 29 | 30 | type testF32 struct { 31 | Name string `csv:"header1"` 32 | Num float32 `csv:"header2"` 33 | } 34 | 35 | // Check the values are correct 36 | func checkValues(tabT []test) bool { 37 | return false || 38 | tabT[0].Name != "line1" || tabT[0].ID != 1 || tabT[0].Num != 1.2 || 39 | tabT[1].Name != "line2" || tabT[1].ID != 2 || tabT[1].Num != 2.3 || 40 | tabT[2].Name != "line3" || tabT[2].ID != 3 || tabT[2].Num != 3.4 41 | } 42 | 43 | func checkBoolValues(tabT []testBool) bool { 44 | return false || 45 | tabT[0].Name != "line1" || tabT[0].ABool != true || 46 | tabT[1].Name != "line2" || tabT[1].ABool != false || 47 | tabT[2].Name != "line3" || tabT[2].ABool != false 48 | } 49 | 50 | func checkFloat32Values(tabT []testF32) bool { 51 | return false || 52 | tabT[0].Name != "line1" || tabT[0].Num != 1.2 || 53 | tabT[1].Name != "line2" || tabT[1].Num != 2.3 54 | } 55 | 56 | func TestValideFile(t *testing.T) { 57 | tabT := []test{} 58 | err := LoadFromPath("csv_files/valid.csv", &tabT) 59 | if err != nil || checkValues(tabT) { 60 | t.Fail() 61 | } 62 | } 63 | 64 | func TestValideFileWithBOM(t *testing.T) { 65 | tabT := []test{} 66 | err := LoadFromPath("csv_files/valid_bom.csv", &tabT) 67 | if err != nil || checkValues(tabT) { 68 | t.Fail() 69 | } 70 | } 71 | 72 | func TestBool(t *testing.T) { 73 | tabT := []testBool{} 74 | err := LoadFromPath("csv_files/bool.csv", &tabT) 75 | if err != nil || checkBoolValues(tabT) { 76 | t.Fail() 77 | } 78 | } 79 | 80 | func TestF32(t *testing.T) { 81 | tabT := []testF32{} 82 | err := LoadFromPath("csv_files/float32.csv", &tabT) 83 | if err != nil || checkFloat32Values(tabT) { 84 | t.Fail() 85 | } 86 | } 87 | 88 | func TestBadHeader(t *testing.T) { 89 | tabT := []test{} 90 | err := LoadFromPath("csv_files/badHeader.csv", &tabT) 91 | if err != nil || checkValues(tabT) { 92 | t.Fail() 93 | } 94 | } 95 | 96 | func TestMissATag(t *testing.T) { 97 | tabT := []testNoID{} 98 | err := LoadFromPath("csv_files/valid.csv", &tabT) 99 | if err != nil || 100 | tabT[0].Name != "line1" || tabT[0].ID != 0 || tabT[0].Num != 0 || 101 | tabT[1].Name != "line2" || tabT[1].ID != 0 || tabT[1].Num != 0 || 102 | tabT[2].Name != "line3" || tabT[2].ID != 0 || tabT[2].Num != 0 { 103 | t.Fail() 104 | } 105 | } 106 | 107 | func TestEmptyFile(t *testing.T) { 108 | tabT := []test{} 109 | err := LoadFromPath("csv_files/empty.csv", &tabT) 110 | if err != nil || len(tabT) != 0 { 111 | t.Fail() 112 | } 113 | } 114 | 115 | func TestNoHeader(t *testing.T) { 116 | tabT := []test{} 117 | err := LoadFromPath( 118 | "csv_files/noHeader.csv", 119 | &tabT, 120 | CsvOptions{Header: []string{"header1", "header2", "header3"}}) 121 | if err != nil || checkValues(tabT) { 122 | t.Fail() 123 | } 124 | } 125 | 126 | func TestWithSemicolon(t *testing.T) { 127 | tabT := []test{} 128 | err := LoadFromPath( 129 | "csv_files/semicolon.csv", 130 | &tabT, 131 | CsvOptions{Separator: ';'}) 132 | if err != nil || checkValues(tabT) { 133 | t.Fail() 134 | } 135 | } 136 | 137 | func TestWithTrailingSpaces(t *testing.T) { 138 | tabT := []test{} 139 | err := LoadFromPath("csv_files/trailingSpaces.csv", &tabT) 140 | if err != nil || checkValues(tabT) { 141 | t.Fail() 142 | } 143 | } 144 | 145 | func TestToMutchOptions(t *testing.T) { 146 | tabT := []test{} 147 | err := LoadFromPath( 148 | "csv_files/semicolon.csv", 149 | &tabT, 150 | CsvOptions{Separator: ';'}, 151 | CsvOptions{Separator: ';'}) 152 | if err == nil { 153 | t.Fail() 154 | } 155 | } 156 | 157 | func TestBadFormat(t *testing.T) { 158 | tabT := []test{} 159 | err := LoadFromPath("csv_files/badFormat.csv", &tabT) 160 | if err == nil { 161 | t.Fail() 162 | } 163 | } 164 | 165 | func TestNonexistingFile(t *testing.T) { 166 | tabT := []test{} 167 | err := LoadFromPath("csv_files/nonexistingfile.csv", &tabT) 168 | if err == nil { 169 | t.Fail() 170 | } 171 | } 172 | 173 | func TestBadInt(t *testing.T) { 174 | tabT := []test{} 175 | err := LoadFromPath("csv_files/badInt.csv", &tabT) 176 | if err == nil { 177 | t.Fail() 178 | } 179 | } 180 | 181 | func TestBadFloat(t *testing.T) { 182 | tabT := []test{} 183 | err := LoadFromPath("csv_files/badFloat.csv", &tabT) 184 | if err == nil { 185 | t.Fail() 186 | } 187 | } 188 | 189 | func TestNoDist(t *testing.T) { 190 | err := LoadFromPath("csv_files/valid.csv", &test{}) 191 | if err == nil { 192 | t.Fail() 193 | } 194 | } 195 | --------------------------------------------------------------------------------