smarter_csv 1.8.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7aa350efc77f90c6986a7573e733b5d9d02930c94465f17d2227b346263a6ce
-  data.tar.gz: 42351edf3e618b8c025f266796897aa0c3572d77e42788a05b1ee37ce8bdeed2
+  metadata.gz: 4a6ec6f3a579d9c1e6bfc2c3c9006f64d8c7b705eeca6ec048ea56c688f8ea1c
+  data.tar.gz: ba9a4a289adcc2fc398ae608f9570c28baac57b877852f3ea37c78fa57f2d7e3
 SHA512:
-  metadata.gz: 8bd9d59d7260a8e90ce472917801b98d088e37de5b1e912914f820f2efbbeb0491f5056d47575debdf1bccb8b9b8670cd089647efa15ec93b02413747dcfe702
-  data.tar.gz: 861364c6213af99c11cd3b9a59b2cf46f8c8e850ee2273e4f1b790714c9cd0ca66a734d64233737e086669c2b6aa51415f1343c3d61811547ec3c715d7a1620c
+  metadata.gz: d8f516501a5539e30789e2d18c4d051f50372786d8df1272192c2bc7997470cf5d5e1ae94b776d0d580cb62ed8ffb0f6591ccc2be5d60eae6e421f22f0c92f94
+  data.tar.gz: 2993c59278adb531cf2299c0aa3869c637868f2f4e6421f845e4ade35011f94ee6e226f43e07b206c67c354c2eb38c0a41981ffbdbff00950690b94b06b2aacd

data/CHANGELOG.md

@@ -1,13 +1,21 @@
 
 # SmarterCSV 1.x Change Log
 
+## 1.8.2 (2023-03-21)
+  * bugfix: do not raise `NoColSepDetected` for CSV files with only one column in most cases (issue #222)
+            If the first lines contain non-ASCII characters, and no col_sep is detected, it will still raise `NoColSepDetected`
+
 ## 1.8.1 (2023-03-19)
   * added validation against invalid values for :col_sep, :row_sep, :quote_char (issue #216)
   * deprecating `required_headers` and replace with `required_keys` (issue #140)
   * fixed issue with require statement
 
-## 1.8.0 (2023-03-18)
+## 1.8.0 (2023-03-18) BREAKING
   * NEW DEFAULTS: `col_sep: :auto`, `row_sep: :auto`. Fully automatic detection by default.
+    
+    MAKE SURE to rescue `NoColSepDetected` if your CSV files can have unexpected formats, 
+              e.g. from users uploading them to a service, and handle those cases.
+
   * ignore Byte Order Marker (BOM) in first line in file (issues #27, #219)
 
 ## 1.7.4 (2023-01-13)

data/README.md

@@ -77,7 +77,10 @@ $ hexdump -C spec/fixtures/bom_test_feff.csv
 
 Here are some examples to demonstrate the versatility of SmarterCSV.
 
-By default SmarterCSV determines the `row_sep` and `col_sep` values automatically.
+**It is generally recommended to rescue `SmarterCSVException` or it's sub-classes.**
+
+By default SmarterCSV determines the `row_sep` and `col_sep` values automatically. In cases where the automatic detection fails, an exception will be raised, e.g. `NoColSepDetected`. Rescuing from these exceptions will make sure that you don't miss processing CSV files, in case users upload CSV files with unexpected formats.
+
 In rare cases you may have to manually set these values, after going through the troubleshooting procedure described above.
 
 #### Example 1a: How SmarterCSV processes CSV-files as array of hashes:

data/TO_DO_v2.md

@@ -0,0 +1,14 @@
+# SmarterCSV v2.0 TO DO List
+
+* add enumerable to speed up parallel processing [issue #66](https://github.com/tilo/smarter_csv/issues/66), [issue #32](https://github.com/tilo/smarter_csv/issues/32)
+* use Procs for validations and transformatoins [issue #118](https://github.com/tilo/smarter_csv/issues/118)
+* make @errors and @warnings work [issue #118](https://github.com/tilo/smarter_csv/issues/118)
+* skip file opening, allow reading from CSV string, e.g. reading from S3 file [issue #120](https://github.com/tilo/smarter_csv/issues/120).
+  Or stream large file from S3 (linked in the issue)
+* Collect all Errors, before surfacing them. Avoid throwing an exception on the first error [issue #133](https://github.com/tilo/smarter_csv/issues/133)
+* Don't call rewind on filehandle
+* [2.0 BUG] :convert_values_to_numeric_unless_leading_zeros drops leading zeros [issue #151](https://github.com/tilo/smarter_csv/issues/151)
+* [2.0 BUG]  convert_to_float saves Proc as @@convert_to_integer [issue #157](https://github.com/tilo/smarter_csv/issues/157)
+* Provide an example for custom Procs for hash_transformations in the docs [issue #174](https://github.com/tilo/smarter_csv/issues/174)
+* Replace remove_empty_values: false [issue #213](https://github.com/tilo/smarter_csv/issues/213)
+

data/lib/smarter_csv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmarterCSV
-  VERSION = "1.8.1"
+  VERSION = "1.8.2"
 end

data/lib/smarter_csv.rb

@@ -393,15 +393,28 @@ module SmarterCSV
     def guess_column_separator(filehandle, options)
       skip_lines(filehandle, options)
 
-      possible_delimiters = [',', "\t", ';', ':', '|']
+      delimiters = [',', "\t", ';', ':', '|']
 
-      candidates = if options.fetch(:headers_in_file)
-                     candidated_column_separators_from_headers(filehandle, options, possible_delimiters)
-                   else
-                     candidated_column_separators_from_contents(filehandle, options, possible_delimiters)
-                   end
+      line = nil
+      has_header = options[:headers_in_file]
+      candidates = Hash.new(0)
+      count = has_header ? 1 : 5
+      count.times do
+        line = readline_with_counts(filehandle, options)
+        delimiters.each do |d|
+          candidates[d] += line.scan(d).count
+        end
+      rescue EOFError # short files
+        break
+      end
+      rewind(filehandle)
 
-      raise SmarterCSV::NoColSepDetected if candidates.values.max == 0
+      if candidates.values.max == 0
+        # if the header only contains
+        return ',' if line =~ /^\w+$/
+
+        raise SmarterCSV::NoColSepDetected
+      end
 
       candidates.key(candidates.values.max)
     end
@@ -582,35 +595,5 @@ module SmarterCSV
       return true if str.is_a?(String) && !str.empty?
       false
     end
-
-    def candidated_column_separators_from_headers(filehandle, options, delimiters)
-      candidates = Hash.new(0)
-      line = readline_with_counts(filehandle, options.slice(:row_sep))
-
-      delimiters.each do |d|
-        candidates[d] += line.scan(d).count
-      end
-
-      rewind(filehandle)
-
-      candidates
-    end
-
-    def candidated_column_separators_from_contents(filehandle, options, delimiters)
-      candidates = Hash.new(0)
-
-      5.times do
-        line = readline_with_counts(filehandle, options.slice(:row_sep))
-        delimiters.each do |d|
-          candidates[d] += line.scan(d).count
-        end
-      rescue EOFError # short files
-        break
-      end
-
-      rewind(filehandle)
-
-      candidates
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smarter_csv
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.2
 platform: ruby
 authors:
 - Tilo Sloboda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-19 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -112,6 +112,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TO_DO_v2.md
 - ext/smarter_csv/extconf.rb
 - ext/smarter_csv/smarter_csv.c
 - lib/extensions/hash.rb