Improved column separator detection by ignoring quoted sections #276
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…quoted occurrences of the delimiter
nicastelo
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #276 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 11 11
Lines 380 382 +2
=========================================
+ Hits 380 382 +2 ☔ View full report in Codecov by Sentry. |
tilo
reviewed
Mar 16, 2024
lib/smarter_csv/auto_detection.rb
Outdated
| @@ -19,7 +19,10 @@ def guess_column_separator(filehandle, options) | |||
| count.times do | |||
| line = readline_with_counts(filehandle, options) | |||
| delimiters.each do |d| | |||
| candidates[d] += line.scan(d).count | |||
| # Count only non-quoted occurrences of the delimiter | |||
| non_quoted_text = line.split(/"[^"]*"|'[^']*'/).join | |||
There was a problem hiding this comment.
@nicastelo :quote_char can be passed in by the user.
It would be better if this would use options[:quote_char]
There was a problem hiding this comment.
@tilo Oops, missed that. Implemented the change, thank you!
|
@nicastelo sorry for the delay - I'll have a look at it this week |
tilo
reviewed
Jul 10, 2024
tilo
reviewed
Jul 10, 2024
tilo
reviewed
Jul 10, 2024
| it 'does not detect separators that are between quotes' do | ||
| data = SmarterCSV.process( | ||
| "#{fixture_path}/separator_chars_between_quotes_no_headers.csv", | ||
| options.merge(user_provided_headers: %w[Name Age Job Department Project]) |
There was a problem hiding this comment.
Suggested change
| options.merge(user_provided_headers: %w[Name Age Job Department Project]) | |
| options.merge(headers_in_file: false, user_provided_headers: %w[Name Age Job Department Project]) |
There was a problem hiding this comment.
important to add headers_in_file: false, otherwise the first line will be ignored
tilo
reviewed
Jul 10, 2024
|
looks good! 👍 |
tilo
approved these changes
Jul 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
This pull request enhances the logic used to determine the column separator (delimiter) in CSV files processed by our system. Previously, the method guess_column_separator simply counted occurrences of potential delimiters (such as commas, tabs, semicolons, colons, and pipes) without considering their context. This could lead to misidentification, especially when non-delimiter characters within quoted fields were mistaken for actual delimiters. The updated logic now intelligently ignores delimiters found within quoted sections, leading to more accurate delimiter detection.
Changes: