csv-format-guesser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 245c4703f769967b17663c5ed17d3925b8a17039
+  data.tar.gz: a298b9967bde06fa11528b5c933a537ef45fc36f
+SHA512:
+  metadata.gz: aa55694a8ff24aa4fe79664c4fc98f44dbe78a58de1e299716211acc4b0d28ff72c62af860e43ccff0bfd2fbbcf24a87932654f7115a936410072c06a74e388d
+  data.tar.gz: 37ecd48383122a1ae088530a60ab8390758ed0e3030c0d70971628c59023da640b39f70d22023472c699048fcaf2f7f077148676bd9b10e0cc526f989cccf246

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csv-format-guesser.gemspec
+gemspec
+gem 'edouard-rchardet', git: 'https://github.com/kirillrdy/rchardet', require: 'rchardet'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GIT
+  remote: https://github.com/kirillrdy/rchardet
+  revision: f0e9f35c199b15b2c9539b3c0e883bb8fb993e84
+  specs:
+    edouard-rchardet (1.3.3)
+
+PATH
+  remote: .
+  specs:
+    csv-format-guesser (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  csv-format-guesser!
+  edouard-rchardet!
+  rake
+  rspec (~> 2.14)

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 olgen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eugen Martin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# CsvFormatGuesser
+
+Guess format and encoding of .csv/.tsv files to generate options compatible with ruby CSV class. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'csv-format-guesser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv-format-guesser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/csv-format-guesser.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv-format-guesser"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Eugen Martin"]
+  spec.email         = ["eugenius martinus ad gmail"]
+  spec.description   = %q{Guess format and encoding of .csv/.tsv files to generate options compatible with ruby CSV class. Works with ruby2.0 }
+  spec.summary       = %q{CSV Format guesser for ruby. Uses rchardet.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "rake"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/lib/csv_format_guesser.rb

@@ -0,0 +1,123 @@
+require 'rchardet'
+class CsvFormatGuesser
+  attr_reader :encoding, :col_sep, :quote_char
+  VERSION = '0.0.1'
+  PREVIEW_LINES = 100
+  PREVIEW_BYTES = 10 * 1024
+
+  def initialize(path)
+    @path = path
+    guess_encoding()
+    guess_col_sep()
+    guess_quote_char()
+  end
+
+  def csv_opts
+    {
+      encoding: @encoding,
+      col_sep: @col_sep,
+      quote_char: @quote_char,
+    }
+  end
+
+  protected
+
+  def guess_encoding
+    cd = CharDet.detect(File.read(@path, PREVIEW_BYTES))
+    @encoding = cd['encoding'] if cd
+    @encoding ||= 'UTF-8'
+    try_encoding_with_fallback!
+  rescue Encoding::UndefinedConversionError => e
+    @encoding = 'ISO-8859-1' if @encoding == 'ISO-8859-7'
+  # rescue => e
+  #   @encoding ||= 'UTF-8'
+  end
+
+  def try_encoding_with_fallback!
+    File.open(@path, "r", encoding: @encoding) do |f|
+      f.read
+    end
+  end
+
+  POTENTIAL_COL_SEP_REGEX = /[^\w ]/i
+  # we assume that the separater is non alphanumeric and has the same
+  # occurencies in the top lines
+  def guess_col_sep
+    header = find_header
+    raise "Could not find header_row from file: #{@path}" unless header
+    char_stats = header.scan(POTENTIAL_COL_SEP_REGEX).inject(Hash.new(0)) {|h,char| h[char]+=1; h}
+    # here we sort all possible col seps by their count in the header
+    @most_appearing = char_stats.to_a.sort{|a,b| b[1] <=> a[1]}.first
+    @col_sep = @most_appearing.first if @most_appearing
+    raise "Could not guess column_separator from file: #{@path}" unless @col_sep
+  rescue => e
+    @col_sep ||= ','
+  end
+
+  def find_header
+    preview_lines.each do |line|
+      return line if line.scan(POTENTIAL_COL_SEP_REGEX).any?
+    end
+  end
+
+  COMMON_QUOTE_CHARS = [ '"', '\'', '|']
+  def guess_quote_char
+    readlines do |line|
+      @quote_char = search_quote_char(line)
+      return if @quote_char
+    end
+    @quote_char ||= select_unused_quote_char
+  rescue => e
+    @quote_char ||= "'"
+  end
+
+  def search_quote_char(line)
+    @used_quote_chars ||= []
+    COMMON_QUOTE_CHARS.each do |char|
+      if line.include?(char)
+        @used_quote_chars << char
+        # should be next to field separator
+        if line.include?(char)
+          is_quote = false
+
+          enclosed = @col_sep + line + @col_sep
+          openings = enclosed.scan( Regexp.new(Regexp.escape(@col_sep+char)) ).length
+          closings = enclosed.scan( Regexp.new(Regexp.escape(char + @col_sep)) ).length
+
+          return char if openings > 0 && openings == closings
+        end
+      end
+    end
+    return nil
+  end
+
+  def select_unused_quote_char
+    COMMON_QUOTE_CHARS.each do |char|
+      return char unless @used_quote_chars.include?(char)
+    end
+    # fallback to an exotic one:
+    return "\x00"
+  end
+
+  def preview_lines
+    @preview_lines ||= readlines(PREVIEW_LINES)
+  end
+
+  def readlines(max = nil, &block)
+    lines = []
+    File.open(@path, "r:#{@encoding}:utf-8") do |f|
+      i = 0
+      f.each_line do |line|
+        i += 1
+        break if max && i > max
+        if block
+          yield(line)
+        else
+          lines << line
+        end
+      end
+    end
+    return lines
+  end
+
+end

data/spec/csv_format_guesser_spec.rb

@@ -0,0 +1,50 @@
+require 'csv'
+require 'csv_format_guesser'
+describe CsvFormatGuesser do
+
+  let(:guesser) { CsvFormatGuesser.new(file) }
+  subject {guesser}
+
+  context 'tab separated' do
+    let(:file) { 'spec/fixtures/files/tab_separated.csv' }
+    its(:col_sep) { should == "\t" }
+    its(:encoding) { should == 'ISO-8859-2' } # latin-2
+    its(:quote_char) { should == "'" }
+  end
+
+
+  context 'hash separated' do
+    let(:file) { 'spec/fixtures/files/hash_separated_utf8.csv' }
+    its(:col_sep) { should == '#' }
+    its(:encoding) { should == 'utf-8' }
+    its(:quote_char) { should == "'" }
+  end
+
+  context 'broken excape' do
+    let(:file) { 'spec/fixtures/files/broken_escape.csv' }
+    its(:col_sep) { should == ';' }
+    its(:encoding) { should == 'utf-8' }
+    its(:quote_char) { should == "'" }
+  end
+
+  context 'navision' do
+    let(:file) { 'spec/fixtures/files/navision_export_sample.csv' }
+    its(:col_sep) { should == ',' }
+    its(:quote_char) { should == '"' }
+    its(:encoding) { should == 'ISO-8859-7' }
+  end
+
+  context 'concurrent # and , as separators' do
+    let(:file) { 'spec/fixtures/files/concurrent_separators.txt' }
+    its(:col_sep) { should == '#' }
+  end
+
+  context 'iso 8859-2' do
+    let(:file) { 'spec/fixtures/files/iso_8859-2.csv' }
+    its(:encoding) { should == 'ISO-8859-2' }
+    its(:col_sep) { should == ';' }
+    its(:quote_char) { should == '"' }
+  end
+
+end
+

data/spec/fixtures/files/broken_escape.csv

@@ -0,0 +1 @@
+950AHL148L;Rettungsweg links, langnachleuchtend "zur Fluchtwegkennzeichnung;HIGHLIGHT Aluminium, langnachleuchtend;Fluchtwegschild: Rettungsweg links HIGHLIGHT Aluminium 14,8 x 29,7 cm Leuchtdichte: HIGHLIGHT 48 mcd/m² gemäß BGV A8, E13;Langnachleuchtende Sicherheitsleitsysteme\Rettungswegbeschilderung nachleuchtende DIN67510\Langnachleuchtende Rettungswegschilder BGV A8\950HLL Schilder langnachleuchtend;950hll.jpg;40200102;58;H07

data/spec/fixtures/files/concurrent_separators.txt

@@ -0,0 +1 @@
+BR586124#3903#>>1#291,50#0,00#291,50#1#291,50#0,00#291,50#1#291,50#0,00#291,50#1#291,50#0,00#291,50#1#291,50#0,00#291,50#1#291,50#0,00#291,50#0

data/spec/fixtures/files/hash_separated_utf8.csv

@@ -0,0 +1 @@
+'Bäschilderung'#5840006#170#Rettungsweg links (BGV A8 E 13)#Kennzeichnung & Schilder>>Rettungszeichen>>Rettungszeichen nach BGV A8 - VGB 125#Material#Kunststoff (langnachleuchtend, selbstklebend)#Größe#148 x 297 mm#Erkennungsweite#14,8 m#######Normen#BGV A8;DIN 67510;;VBG 125#Materialeigenschaften

data/spec/fixtures/files/iso_8859-2.csv

@@ -0,0 +1,3 @@
+alt (PA / A-B);20101406;7,83321E+11;92553;50751235;l�r;;;;;36,95;36;36;;18,6;;;;1;1;;;;;;;
+alt (PA / A-B);20101406;7,83321E+11;92553;50751235;l�r;;;;;36,95;36;36;;18,6;;;;1;1;;;;;;;
+alt (PA / A-B);20101406;7,83321E+11;92553;50751235;l�r;;;;;36,95;36;36;;18,6;;;;1;1;;;;;;;

data/spec/fixtures/files/navision_export_sample.csv

@@ -0,0 +1 @@
+12345,"Losgr��enrundungsfaktor",Awesome,Selbstbr�unungsspray,100 ml,women

data/spec/fixtures/files/tab_separated.csv

@@ -0,0 +1,2 @@
+artnr	herstnr	artname	hersteller
+990477	EZ.PCM03.007	'Z Zubeh�r  Deckenhalterung universal'	Acer Computer GmbH

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: csv-format-guesser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eugen Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-23 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: 'Guess format and encoding of .csv/.tsv files to generate options compatible
+  with ruby CSV class. Works with ruby2.0 '
+email:
+- eugenius martinus ad gmail
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- csv-format-guesser.gemspec
+- lib/csv_format_guesser.rb
+- spec/csv_format_guesser_spec.rb
+- spec/fixtures/files/broken_escape.csv
+- spec/fixtures/files/concurrent_separators.txt
+- spec/fixtures/files/hash_separated_utf8.csv
+- spec/fixtures/files/iso_8859-2.csv
+- spec/fixtures/files/navision_export_sample.csv
+- spec/fixtures/files/tab_separated.csv
+homepage: ''
+licenses:
+- MIT
+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.6
+signing_key: 
+specification_version: 4
+summary: CSV Format guesser for ruby. Uses rchardet.
+test_files:
+- spec/csv_format_guesser_spec.rb
+- spec/fixtures/files/broken_escape.csv
+- spec/fixtures/files/concurrent_separators.txt
+- spec/fixtures/files/hash_separated_utf8.csv
+- spec/fixtures/files/iso_8859-2.csv
+- spec/fixtures/files/navision_export_sample.csv
+- spec/fixtures/files/tab_separated.csv