hippie_csv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99c371eea25788cf2b155a089ef2378ce564a039
+  data.tar.gz: 53c18182171b267f4c6a13f50b8672d39e177296
+SHA512:
+  metadata.gz: 30ece254d7ba4e882d529c839fafa551979b3974d2af14ced46587d369a99ff94d9a3528bddac6ea174761a4430bd1d3b223717a5791cf8559218024da14f507
+  data.tar.gz: d9ce69502180d757d890d69b30985a7200ab9611f1694bbb140c399c2e577764c07d2839a7e9cea856d8767de23dbe6a463e52f44645c3a3b089a8e49e3acf45

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                             Apache License
+                       Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+  replaced with your own identifying information. (Don't include
+  the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same "printed page" as the copyright notice for easier
+  identification within third-party archives.
+
+Copyright 2014 Intercom, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,63 @@
+# HippieCSV
+
+[ ![Codeship Status for intercom/hippie_csv](https://codeship.com/projects/f3b188e0-f312-0132-75cb-5ed004d44c71/status?branch=master)](https://codeship.com/projects/85324)
+
+Ruby's `CSV` is great. It complies with the [proposed CSV spec](https://www.ietf.org/rfc/rfc4180.txt)
+pretty well. If you pass its methods bad or incompliant CSVs, it’ll rightfully
+and loudly complain. It’s great 👍
+
+Except…if you want to be able to deal with files from the real world. At
+[Intercom](https://intercom.io), we’ve seen lots of problematic CSVs from
+customers importing data to our system. You may want to support such cases.
+You may not always know the delimiter, nor the chosen quote character, in
+advance.
+
+HippieCSV is a ridiculously tolerant and liberal parser which aims to yield as
+much usable data as possible out of such real-world CSVs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hippie_csv'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hippie_csv
+
+## Usage
+
+Exposes two public methods: `read` (for paths to files), and `parse` (for
+strings).
+
+```ruby
+require 'hippie_csv'
+
+HippieCSV.read("path/to/data.csv")
+
+HippieCSV.parse(csv_string)
+```
+
+## Features
+
+- Deduces the delimiter (supports `,`, `;`, and `|`)
+- Deduces the quote character (supports `'` and `"`)
+- Forgives backslash escaped quotes in quoted CSVs
+- Forgives invalid newlines in quoted CSVs
+- Heals many encoding issues (and aggressively forces UTF-8)
+- Deals with many miscellaneous malformed types of CSVs
+- Works when a [byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark) is present
+
+## Contributing
+
+1. Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+2. Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+3. Fork the project.
+4. Start a feature/bugfix branch.
+5. Commit and push until you are happy with your contribution.
+6. Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+7. Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so we can cherry-pick around it.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hippie_csv.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hippie_csv/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hippie_csv"
+  spec.version       = HippieCSV::VERSION
+  spec.authors       = ["Stephen O'Brien"]
+  spec.email         = ["stephen@intercom.io"]
+  spec.summary       = %q{Tolerant, liberal CSV parsing}
+  spec.homepage      = ""
+  spec.license       = "Apache License, Version 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/hippie_csv/constants.rb

@@ -0,0 +1,10 @@
+require 'csv'
+
+module HippieCSV
+  QUOTE_CHARACTERS = %w(" ' |).freeze
+  DELIMETERS = %W(, ; \t).freeze
+  ENCODING = "utf-8".freeze
+  ALTERNATE_ENCODING = "utf-16".freeze
+  FIELD_SAMPLE_COUNT = 10
+  ENCODING_WITH_BOM = "bom|#{ENCODING}".freeze
+end

data/lib/hippie_csv/errors.rb

@@ -0,0 +1,7 @@
+module HippieCSV
+  class UnableToParseError < StandardError
+    def self.explain
+      raise new "Something went wrong. Report this CSV: https://github.com/intercom/hippie_csv"
+    end
+  end
+end

data/lib/hippie_csv/support.rb

@@ -0,0 +1,63 @@
+require "hippie_csv/constants"
+
+module HippieCSV
+  module Support
+    class << self
+      def file_path_to_string(file_path)
+        File.read(file_path, encoding: ENCODING_WITH_BOM)
+      end
+
+      def encode!(string)
+        unless string.valid_encoding?
+          string.encode!(ALTERNATE_ENCODING, ENCODING, invalid: :replace, replace: "")
+          string.encode!(ENCODING, ALTERNATE_ENCODING)
+        end
+
+        string.encode!(string.encoding, universal_newline: true)
+      end
+
+      def maybe_parse(string)
+        QUOTE_CHARACTERS.find do |quote_character|
+          Support.rescuing_malformed do
+            return Support.parse_csv(string, quote_character)
+          end
+        end
+      end
+
+      def parse_csv(string, quote_character)
+        CSV.parse(
+          tolerate_escaping(string, quote_character),
+          quote_char: quote_character,
+          col_sep: guess_delimeter(string, quote_character)
+        )
+      end
+
+      def rescuing_malformed
+        begin; yield; rescue CSV::MalformedCSVError; end
+      end
+
+      def tolerate_escaping(string, quote_character)
+        string.gsub("\\#{quote_character}", "#{quote_character}#{quote_character}")
+      end
+
+      def guess_delimeter(string, quote_character)
+        results = DELIMETERS.map do |delimeter|
+          [delimeter, field_count(string, delimeter, quote_character)]
+        end.max_by do |delimeter, count|
+          count
+        end.each do |delimiter, count|
+          return delimiter
+        end
+      end
+
+      private
+
+      def field_count(file, delimeter, quote_character)
+        csv = CSV.new(file, col_sep: delimeter, quote_char: quote_character)
+        csv.lazy.take(FIELD_SAMPLE_COUNT).map(&:size).inject(:+)
+      rescue CSV::MalformedCSVError
+        0
+      end
+    end
+  end
+end

data/lib/hippie_csv/version.rb

@@ -0,0 +1,3 @@
+module HippieCSV
+  VERSION = "0.0.1"
+end

data/lib/hippie_csv.rb

@@ -0,0 +1,15 @@
+require "hippie_csv/version"
+require "hippie_csv/support"
+require "hippie_csv/errors"
+
+module HippieCSV
+  def self.read(path)
+    string = Support.file_path_to_string(path)
+    parse(string)
+  end
+
+  def self.parse(string)
+    Support.encode!(string)
+    Support.maybe_parse(string) || UnableToParseError.explain
+  end
+end

data/spec/fixtures/dos_line_ending.csv

@@ -0,0 +1 @@
+m_id,first_name,last_name,email,Gender,Country,Applications2014,Member_Type,Length_Months

data/spec/fixtures/escaped_quotes.csv

@@ -0,0 +1,2 @@
+831819,"Lalo \"ElPapi\" Neymar","lalo@example.com","16/04/2015",,1,"16/04/2015","23/04/2015"
+831852,"BlazinShovels","blazinshovels@example.com","16/04/2015",,1,"20/04/2015","26/04/2015"

data/spec/fixtures/escaped_quotes_semicolons.csv

@@ -0,0 +1 @@
+"133";"z3268856";"stephen@example.com";"23/9/2012";"23/9/2012";"1348368705";"1";;"sites/default/files/pictures/default-6.jpg";"2";"example.com"

data/spec/fixtures/excel.csv

@@ -0,0 +1,56 @@
+Basic Pricing,,,,,,,,,,,,,,,,,,,,,,,
+,,,,,,,,Per Package Upgrades,,,,,,,Plan Ratios,,,,,,,,
+Est Company Size,Est. Employee Size,End Users,Product,Support,Marketing,Everything,,Base,Product,Support,Marketing,Everything,Check,,Product ,Support,Marketing,,Check,Check,Check,,
+Side,1,"1,000",-,-,-,$49 ,,,,,,$49 ,,,,,,,,,,,
+Side,2,"2,000",-,-,-,$79 ,,,,,,$79 ,,,,,,,,,,,
+Pre-Seed,2,"3,000",$49 ,$59 ,$69 ,$99 ,,$39 ,$10 ,$20 ,$30 ,$99 ,$0 ,,49% ,60% ,70% ,,$0 ,$0 ,$0 ,,
+Pre-Seed,4,"5,000",$59 ,$69 ,$79 ,$109 ,,$49 ,$10 ,$20 ,$30 ,$109 ,$0 ,,54% ,63% ,72% ,,$0 ,$0 ,$0 ,,
+Seed,4,"10,000",$69 ,$79 ,$99 ,$149 ,,$49 ,$20 ,$30 ,$50 ,$149 ,$0 ,,46% ,53% ,66% ,,$0 ,$0 ,$0 ,,
+Seed,7,"15,000",$109 ,$119 ,$149 ,$219 ,,$79 ,$30 ,$40 ,$70 ,$219 ,$0 ,,50% ,54% ,68% ,,$0 ,$0 ,$0 ,,
+Seed,9,"20,000",$159 ,$179 ,$219 ,$299 ,,$129 ,$30 ,$50 ,$90 ,$299 ,$0 ,,53% ,60% ,73% ,,$0 ,$0 ,$0 ,,
+Series A,10,"25,000",$209 ,$239 ,$289 ,$399 ,,$169 ,$40 ,$70 ,$120 ,$399 ,$0 ,,52% ,60% ,72% ,,$0 ,$0 ,$0 ,,
+Series A,20,"35,000",$299 ,$319 ,$389 ,$549 ,,$229 ,$70 ,$90 ,$160 ,$549 ,$0 ,,54% ,58% ,71% ,,$0 ,$0 ,$0 ,,
+Series B/B+,25,"50,000",$379 ,$409 ,$489 ,$699 ,,$289 ,$90 ,$120 ,$200 ,$699 ,$0 ,,54% ,59% ,70% ,,$0 ,$0 ,$0 ,,
+,,,,,,,,,,,,,,,,,,,,,,,
+,,,,,,,,,,,,,,,,,,,,,,,
+Pro Pricing,,Multiple,161% ,,,,,,,,,,,,,,,,,,,,
+,,,,,,,,Per Package Upgrades,,,,,,,Plan Ratios,,,,,,,,
+Est Company Size,Est. Employee Size,End Users,Product,Support,Marketing,Everything,,Base,Product,Support,Marketing,Everything,Check,,Product ,Support,Marketing,,Check,Check,Check,,
+Side,1,"1,000",,,,$79 ,,,,,,$79 ,,,,,,,,,,,
+Side,2,"2,000",,,,$127 ,,,,,,$127 ,,,,,,,,,,,
+Pre-Seed,2,"3,000",$79 ,$95 ,$111 ,$159 ,,$63 ,$16 ,$32 ,$48 ,$159 ,$0 ,,49% ,60% ,70% ,,$0 ,$0 ,$0 ,,
+Pre-Seed,4,"5,000",$95 ,$111 ,$127 ,$175 ,,$79 ,$16 ,$32 ,$48 ,$175 ,$0 ,,54% ,63% ,72% ,,$0 ,$0 ,$0 ,,
+Seed,4,"10,000",$111 ,$127 ,$159 ,$239 ,,$79 ,$32 ,$48 ,$80 ,$239 ,$0 ,,46% ,53% ,66% ,,$0 ,$0 ,$0 ,,
+Seed,7,"15,000",$175 ,$191 ,$239 ,$352 ,,$127 ,$48 ,$64 ,$112 ,$352 ,$0 ,,50% ,54% ,68% ,,$0 ,$0 ,$0 ,,
+Seed,9,"20,000",$255 ,$288 ,$352 ,$480 ,,$207 ,$48 ,$80 ,$145 ,$480 ,$0 ,,53% ,60% ,73% ,,$0 ,$0 ,$0 ,,
+Series A,10,"25,000",$336 ,$384 ,$464 ,$641 ,,$272 ,$64 ,$112 ,$193 ,$641 ,$0 ,,52% ,60% ,72% ,,$0 ,$0 ,$0 ,,
+Series A,20,"35,000",$480 ,$512 ,$625 ,$882 ,,$368 ,$112 ,$145 ,$257 ,$882 ,$0 ,,54% ,58% ,71% ,,$0 ,$0 ,$0 ,,
+Series B/B+,25,"50,000",$609 ,$657 ,$786 ,"$1,123 ",,$464 ,$145 ,$193 ,$321 ,"$1,123 ",$0 ,,54% ,59% ,70% ,,$0 ,$0 ,$0 ,,
+,,,,,,,,,,,,,,,,,,,,,,,
+,,,,,,,,,,,,,,,,,,,,,,,
+,,,Prices,,,,,,,,,,,,,,,,,,,,
+,Company 1,,Company 2,Company 3,Company 4,,,,,,,,,,,,,,,,,,
+Side,1,"1,000",,,,$30 ,,,,,,,,,,,,,,,,,
+,2,"2,000",,,,$48 ,,,,,,,,,,,,,,,,,
+Pre-Seed,2,"3,000",$45 ,$38 ,$31 ,$60 ,,,,,,,,,,,,,,,,,
+,4,"5,000",$55 ,$49 ,$43 ,$66 ,,,,,,,,,,,,,,,,,
+Seed,4,"10,000",$64 ,$75 ,$55 ,$90 ,,,,,,,,,,,,,,,,,
+,7,"15,000",$74 ,$102 ,$67 ,$133 ,,,,,,,,,,,,,,,,,
+,9,"20,000",$83 ,$129 ,$79 ,$181 ,,,,,,,,,,,,,,,,,
+Series A,10,"25,000",$87 ,$186 ,$86 ,$242 ,,,,,,,,,,,,,,,,,
+,20,"35,000",$125 ,$243 ,$93 ,$333 ,,,,,,,,,,,,,,,,,
+Series B/B+,25,"50,000",$187 ,$300 ,$100 ,$424 ,,,,,,,,,,,,,,,,,
+,,,,,,,,,,,,,,,,,,,,,,,
+,Employee Size,,,,,,,,,,,,,,,,,,,,,,
+Side,1,,,,,,,,,,,,,,,,,,,,,,
+,2,,,,,,,,,,,,,,,,,,,,,,
+Pre-Seed,2,,92% ,64% ,45% ,,,,,,,,,,,,,,,,,,
+,4,,93% ,71% ,54% ,,,,,,,,,,,,,,,,,,
+Seed,4,,93% ,95% ,56% ,,,,,,,,,,,,,,,,,,
+,7,,67% ,86% ,45% ,,,,,,,,,,,,,,,,,,
+,9,,52% ,72% ,36% ,,,,,,,,,,,,,,,,,,
+Series A,10,,42% ,78% ,30% ,,,,,,,,,,,,,,,,,,
+,20,,42% ,76% ,24% ,,,,,,,,,,,,,,,,,,
+Series B/B+,25,,49% ,73% ,20% ,,,,,,,,,,,,,,,,,,
+,Avg,,66% ,77% ,39% ,61% ,,,,,,,,,,,,,,,,,
+,,,,,,,,,,,,,,,,,,,,,,,

data/spec/fixtures/malformed.csv

@@ -0,0 +1,4 @@
+site,lon,lat,max,min,precip,snow,snowdepth
+1V4,-72.02,44.42,13,-5,0.01,-99,-99
+MPV,-72.56,44.20,1"2,-4,0.00,-99,-99
+BTV,-73.15,44.47,14,-9,0.00,0.0,7,52

data/spec/fixtures/normal.csv

@@ -0,0 +1,14 @@
+id,email,name,country,city,created_at,admin
+102,patrick@intercom.io,Patrick O'Doherty,United States,San Francisco,2014-04-28 23:57:08 UTC,true
+103,ben@intercom.io,Ben McRedmond,United States,San Francisco,2014-04-27 23:57:08 UTC,false
+104,ciaran@intercom.io,Ciaran Lee,Ireland,Dublin,2014-04-26 23:57:08 UTC,true
+105,eoghan@intercom.io,Eoghan McCabe,United States,San Francisco,2014-04-25 23:57:08 UTC,true
+106,des@intercom.io,Des Traynor,Ireland,Dublin,2014-04-24 23:57:08 UTC,true
+107,darragh@intercom.io,Darragh Curran,Ireland,Dublin,2014-04-23 23:57:08 UTC,true
+108,jeff@intercom.io,Jeff Gardner,Italy,Prata Camportaccio,2014-04-22 23:57:08 UTC,true
+109,macey@intercom.io,Macey Baker,United States,San Francisco,2014-04-21 23:57:08 UTC,true
+110,adam@intercom.io,Adam McCarthy,Dublin,Ireland,2014-04-20 23:57:08 UTC,true
+111,declan@intercom.io,Declan McGrath,Dublin,Ireland,2014-04-19 23:57:08 UTC,false
+112,peter@intercom.io,Peter McKenna,Dublin,Ireland,2014-04-18 23:57:08 UTC,false
+113,david@intercom.io,David Barett,Dublin,Ireland,2014-04-17 23:57:08 UTC,true
+114,eoin@intercom.io,Eoin Hennessy,Dublin,Ireland,2014-04-16 23:57:08 UTC,false

data/spec/fixtures/with_byte_order_mark.csv

@@ -0,0 +1 @@
+"Name","Email Address","Date Added"

data/spec/hippie_csv/constants_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe HippieCSV do
+
+  describe "::QUOTE_CHARACTERS" do
+    let(:supported_quote_characters) { ['"', "'", "|"] }
+
+    it "defines supported quote characters" do
+      expect(HippieCSV::QUOTE_CHARACTERS).to match(supported_quote_characters)
+    end
+
+    it "is not modifiable" do
+      expect(HippieCSV::QUOTE_CHARACTERS).to be_frozen
+    end
+  end
+
+  describe "::DELIMETERS" do
+    let(:supported_delimiters) { [",", ";", "\t"] }
+
+    it "defines supported delimeters" do
+      expect(HippieCSV::DELIMETERS).to match(supported_delimiters)
+    end
+
+    it "is not modifiable" do
+      expect(HippieCSV::DELIMETERS).to be_frozen
+    end
+  end
+
+  describe "::ENCODING" do
+    it "encodes as UTF-8" do
+      expect(HippieCSV::ENCODING).to eq('utf-8')
+    end
+
+    it "is not modifiable" do
+      expect(HippieCSV::ENCODING).to be_frozen
+    end
+  end
+
+  describe "::ALTERNATE_ENCODING" do
+    it "defines an alternative encoding for temporary force encoding purposes" do
+      expect(HippieCSV::ALTERNATE_ENCODING).to eq('utf-16')
+    end
+
+    it "is not modifiable" do
+      expect(HippieCSV::ALTERNATE_ENCODING).to be_frozen
+    end
+  end
+
+  describe "::FIELD_SAMPLE_COUNT" do
+    it "considers the first 10 rows when sampling from a CSV" do
+      expect(HippieCSV::FIELD_SAMPLE_COUNT).to eq(10)
+    end
+
+    it "is not modifiable" do
+      expect(HippieCSV::FIELD_SAMPLE_COUNT).to be_frozen
+    end
+  end
+
+  describe "::ENCODING_WITH_BOM" do
+    it "provides an encoding string supporting byte order mark" do
+      expect(HippieCSV::ENCODING_WITH_BOM).to eq('bom|utf-8')
+    end
+
+    it "is not modifiable" do
+      expect(HippieCSV::ENCODING_WITH_BOM).to be_frozen
+    end
+  end
+end

data/spec/hippie_csv/support_spec.rb

@@ -0,0 +1,112 @@
+require "spec_helper"
+
+describe HippieCSV::Support do
+
+  describe ".file_to_string" do
+    let(:file_path) { fixture_path(:normal) }
+    let(:result) { HippieCSV::Support.file_path_to_string(file_path) }
+
+    it "provides a string" do
+      expect(result.class).to eq String
+    end
+
+    it "reads the file" do
+      expect(result.slice(0,8)).to eq 'id,email'
+    end
+
+    context "with a byte order mark" do
+      let(:file_path) { fixture_path(:with_byte_order_mark) }
+
+      it "works" do
+        expect(result).to eq '"Name","Email Address","Date Added"'
+      end
+    end
+  end
+
+  describe ".encode!" do
+    context "with invalid byte sequence" do
+      let(:string) { "\u0014\xFE\u000E\u0000" }
+
+      it "would error normally" do
+        expect { CSV.parse(string) }.to raise_error(ArgumentError, "invalid byte sequence in UTF-8")
+      end
+
+      it "works" do
+        expect(string).not_to be_valid_encoding
+
+        subject.encode!(string)
+
+        expect(string).to be_valid_encoding
+      end
+    end
+
+    context 'with unquoted fields and \r or \n' do
+      let(:string) { "id,first_name,last_name\r123,Heinrich,Schütz\r\n" }
+
+      it "would error normally" do
+        expect { CSV.parse(string) }.to raise_error(CSV::MalformedCSVError, "Unquoted fields do not allow \\r or \\n (line 3).")
+      end
+
+      it "works" do
+        subject.encode!(string)
+
+        result = CSV.parse(string)
+        rows, columns = result.size, result.first.size
+
+        expect(rows).to eq(2)
+        expect(columns).to eq(3)
+      end
+    end
+  end
+
+  describe ".maybe_parse" do
+    it "needs to be written" do
+      skip # TODO write this test
+    end
+  end
+
+  describe ".parse_csv" do
+    let(:string) { "name,email\nstephen,test@example.com"}
+    let(:quote_character) { "\"" }
+
+    it "works" do
+      expect(subject).to receive(:guess_delimeter).with(string, quote_character).and_return(',')
+      expect(subject).to receive(:tolerate_escaping).with(string, quote_character).and_return(string)
+
+      expect(subject.parse_csv(string, quote_character)).to eq(
+        [["name", "email"], ["stephen", "test@example.com"]]
+      )
+    end
+  end
+
+  describe ".rescuing_malformed" do
+    let(:error) { CSV::MalformedCSVError }
+    let(:will_error) { -> { raise error } }
+
+    it "would normally error" do
+      expect { will_error.call }.to raise_error(error)
+    end
+
+    it "rescues from CSV::MalformedCSVError" do
+      expect { subject.rescuing_malformed { will_error.call } }.not_to raise_error
+    end
+  end
+
+  describe ".tolerate_escaping" do
+    let(:string) { "'Stephen', 'O\\'Brien'"}
+    let(:quote_character) { "'" }
+
+    it "enforces escaping according to CSV spec" do
+      expect(subject.tolerate_escaping(string, quote_character)).to eq("'Stephen', 'O''Brien'")
+    end
+  end
+
+  describe ".guess_delimeter" do
+    let(:string) { "'a'\t'b'\t'c'\n'd'\t'e'\t'f'\n" }
+    let(:quote_character) { "'" }
+
+    it "deduces the delimiter based on counts" do
+      expect(subject.guess_delimeter(string, quote_character)).to eq("\t")
+    end
+  end
+end

data/spec/hippie_csv/version_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe HippieCSV do
+
+  it "defines a version" do
+    expect(HippieCSV::VERSION).to eq('0.0.1')
+  end
+
+end

data/spec/hippie_csv_spec.rb

@@ -0,0 +1,104 @@
+require "spec_helper"
+require "csv"
+
+describe HippieCSV do
+  let(:string) { "test" }
+
+  describe ".read" do
+    let(:path) { double }
+
+    it "converts to string and parses" do
+      expect(subject::Support).to receive(:file_path_to_string).with(path).and_return(string)
+      expect(subject).to receive(:parse).with(string)
+
+      subject.read(path)
+    end
+  end
+
+  describe ".parse" do
+    it "encodes the string" do
+      expect(subject::Support).to receive(:encode!).with(string)
+
+      subject.parse(string)
+    end
+
+    it "defers to support parse method" do
+      result = double
+      expect(subject::Support).to receive(:maybe_parse).with(string).and_return(result)
+
+      expect(subject.parse(string)).to eq(result)
+    end
+
+    context "when unable to parse" do
+      before do
+        expect(subject::Support).to receive(:maybe_parse).and_return(nil)
+      end
+
+      it "raises an error" do
+        expect {
+          subject.parse(string)
+        }.to raise_error(
+          subject::UnableToParseError,
+          "Something went wrong. Report this CSV: https://github.com/intercom/hippie_csv"
+        )
+      end
+    end
+  end
+
+  context "integration cases: hard/encountered problems" do
+    it "works when a BOM is present in the file" do
+      path = fixture_path(:with_byte_order_mark)
+      expect { CSV.read(path) }.to raise_error(CSV::MalformedCSVError)
+
+      import = subject.read(path)
+      expect(import[0]).to eq(["Name", "Email Address", "Date Added"])
+    end
+
+    it "works with a malformed CSV" do
+      path = fixture_path(:malformed)
+      expect { CSV.read(path) }.to raise_error(CSV::MalformedCSVError)
+
+      import = subject.read(path)
+      expect(import[0]).to eq(%w(site lon lat max min precip snow snowdepth))
+    end
+
+    it "works with odd encoding & emoji!" do
+      path = fixture_path(:encoding)
+      expect { CSV.read(path) }.to raise_error(ArgumentError)
+
+      import = subject.read(path)
+      expect(import[0].count).to eq(4)
+    end
+
+    it "works with an excel export" do
+      path = fixture_path(:excel)
+
+      import = subject.read(path)
+      expect(import[0].count).to eq(24)
+    end
+
+    it "works with escaped quotes" do
+      path = fixture_path(:escaped_quotes)
+
+      import = subject.read(path)
+      expect(import[0][1]).to eq("Lalo \"ElPapi\" Neymar")
+      expect(import[0][2]).to eq("lalo@example.com")
+    end
+
+    it "works with an invalid escaped quotes case" do
+      path = fixture_path(:escaped_quotes_semicolons)
+
+      import = subject.read(path)
+      expect(import[0][0]).to eq("133")
+      expect(import[0][1]).to eq("z3268856")
+      expect(import[0][2]).to eq("stephen@example.com")
+    end
+
+    it "works for a complicated case involving bad newlines and quote chars" do
+      path = fixture_path(:dos_line_ending)
+
+      import = subject.read(path)
+      expect(import[0].count).to eq(9)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "hippie_csv"
+
+def fixture_path(name)
+  File.expand_path("../fixtures/#{name}.csv", __FILE__)
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: hippie_csv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen O'Brien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- stephen@intercom.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hippie_csv.gemspec
+- lib/hippie_csv.rb
+- lib/hippie_csv/constants.rb
+- lib/hippie_csv/errors.rb
+- lib/hippie_csv/support.rb
+- lib/hippie_csv/version.rb
+- spec/fixtures/dos_line_ending.csv
+- spec/fixtures/encoding.csv
+- spec/fixtures/escaped_quotes.csv
+- spec/fixtures/escaped_quotes_semicolons.csv
+- spec/fixtures/excel.csv
+- spec/fixtures/malformed.csv
+- spec/fixtures/normal.csv
+- spec/fixtures/with_byte_order_mark.csv
+- spec/hippie_csv/constants_spec.rb
+- spec/hippie_csv/support_spec.rb
+- spec/hippie_csv/version_spec.rb
+- spec/hippie_csv_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- Apache License, Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Tolerant, liberal CSV parsing
+test_files:
+- spec/fixtures/dos_line_ending.csv
+- spec/fixtures/encoding.csv
+- spec/fixtures/escaped_quotes.csv
+- spec/fixtures/escaped_quotes_semicolons.csv
+- spec/fixtures/excel.csv
+- spec/fixtures/malformed.csv
+- spec/fixtures/normal.csv
+- spec/fixtures/with_byte_order_mark.csv
+- spec/hippie_csv/constants_spec.rb
+- spec/hippie_csv/support_spec.rb
+- spec/hippie_csv/version_spec.rb
+- spec/hippie_csv_spec.rb
+- spec/spec_helper.rb