csv-autoparser 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53747202951399caaf327f39b27c05bea53adb65
-  data.tar.gz: 393d57c30af9348ef1f2e20d9b31e2dd9447b297
+  metadata.gz: 44a33cdb6c52087bcfe3667389cdcccab742a9d5
+  data.tar.gz: 1900f568e8c11343e69d8dc05a7ae8ea8bfe0304
 SHA512:
-  metadata.gz: 694f349ba315f419dfd12d0e95a8c4bcc817fdf14d84bfe0b2c5732ef75008d59e1d7766edd8b6d5c4d8ec76fb6323ad53642a157fbf6a8431bc9e1e0aeb2cdf
-  data.tar.gz: 7ef182a5fdef94fef12741d77279a158c43b989c3e0c3752a65545e0b5ff802f2d359a2e8f343449c4863bc135ade02058d77dec6266d3da58a375031ceb2462
+  metadata.gz: 095abf30f884f42fd177fbf97b17f9aca67cf56fc629854b2dd2a97571c0e2109ce3c6b2d1c717298686ace768de7bd991579db304ba29830c40cdd6329ecd70
+  data.tar.gz: de518ddbd0e8119ce170fad55ad36194d073c746ac8dcbd68fa9237683c679b05fdf950da8549b815d4c2bc14a8ee1063d4fdfdecae0cb51b0bbeaf5b92da220

data/lib/csv/autoparser.rb

@@ -4,6 +4,7 @@ require "csv/autoparser/version"
 class CSV
 
   class Row
+    attr_reader :line_number
     alias_method :orig_initialize, :initialize
     # Defines method style accessors based on header row names.
     def initialize(*args)
@@ -27,17 +28,17 @@ class CSV
     # The rows found before the header row are paired with file and line information. These
     # objects are available through CSV::AutoParser#pre_header_rows.
     class PreHeaderRow < Array
-      attr_reader :file, :line
+      attr_reader :line_number
       def self.create original_row, file, line
         row = PreHeaderRow.new(original_row)
-        row.instance_eval { @file = file; @line = line }
+        row.instance_eval { @line_number = line }
         return row
       end
     end
 
     class HeaderRowNotFound < RuntimeError; end
 
-    attr_reader :pre_header_rows, :header_line_number
+    attr_reader :pre_header_rows, :header_line_number, :file_path
 
     # +data+ can be path of CSV file in addition to a CSV String or an IO object like CSV.new.
     # All CSV.new options are supported via +opts+. If an +&is_header+ block is provided, it 
@@ -48,45 +49,49 @@ class CSV
       @header_line_number = nil
       @pre_header_rows = []
       @optional_headers = [opts.delete(:optional_headers)].flatten.compact
-      if data.is_a?(String) and File.exists?(data)
-        file = data
-        data = File.open(data) 
-      end
+      @data_io = if data.is_a?(IO) or data.is_a?(StringIO)
+                   data
+                 elsif data.is_a?(String)
+                   if File.exists?(data)
+                     File.open(@file_path = File.expand_path(data), binmode: true) 
+                   else
+                     StringIO.new(data)
+                   end
+                 else
+                   raise ArgumentError, "data must be a path to a CSV file, a CSV formatted String, or an IO object."
+                 end
       if block_given?
-        data_io = if data.is_a?(IO)
-                    data
-                  elsif data.is_a?(String)
-                    StringIO.new(data)
-                  else
-                    raise ArgumentError, "data must be a path to a CSV file, a CSV formatted String, or an IO object."
-                  end
-        header_pos = data_io.pos
+        header_pos = @data_io.pos
         csv_line_number = 0
-        header_finder = CSV.new(data_io, opts.merge(:headers => false)).each do |row| 
+        header_finder = CSV.new(@data_io, opts.merge(:headers => false)).each do |row| 
           csv_line_number += 1
           if is_header.call(csv_line_number, row)
             @header_line_number = csv_line_number
             break
           else
-            @pre_header_rows << CSV::AutoParser::PreHeaderRow.create(row, file, csv_line_number)
+            @pre_header_rows << CSV::AutoParser::PreHeaderRow.create(row, @file_path, csv_line_number)
           end
-          header_pos = data_io.pos
+          header_pos = @data_io.pos
         end
-        raise HeaderRowNotFound, "Could not find header row#{file ? " in #{file}" : "" }." if @header_line_number.nil?
-        data_io.seek header_pos
-        data_io = StringIO.new(data_io.read)
-        super(data_io, opts.merge(:headers => true))
+        raise HeaderRowNotFound, "Could not find header row#{@file_path ? " in #{@file_path}" : "" }." if @header_line_number.nil?
+        @data_io.seek header_pos
+        @data_io = StringIO.new(@data_io.read)
+        super(@data_io, opts.merge(:headers => true))
       else
         @header_line_number = 1 if opts[:headers] == :first_row or opts[:headers] == true
-        super(data, opts)
+        super(@data_io, opts)
       end
     end
 
     alias_method :orig_shift, :shift
 
-    # Overriden to add methods for optional headers which were not present in the CSV.
+    # Overriden to add methods for optional headers which were not present in the CSV. Also, 
+    # sets a rows @file_path and @line_number.
     def shift
       row = orig_shift
+      if row and row.is_a?(Row) and row.line_number.nil? # sometimes nil. sometimes not a row. sometimes row is repeated.
+        row.instance_variable_set(:@line_number, @data_io.lineno + (@header_line_number || 1) - 1) #if @data_io
+      end
       [@optional_headers].flatten.compact.each do |h|
         method_name = self.class.convert_header_to_method_name(h)
         unless row.respond_to? method_name

data/lib/csv/autoparser/version.rb

@@ -1,5 +1,5 @@
 class CSV
   class AutoParser < CSV
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/test/test_csv/autoparser.rb

@@ -30,8 +30,25 @@ describe CSV::AutoParser do
     parser.header_line_number.must_equal 3
     parser.pre_header_rows.first.last.must_equal "years of age"
     parser.pre_header_rows.last.first.must_equal "bob"
-    File.basename(parser.pre_header_rows.last.file).must_equal "persons.csv"
-    parser.pre_header_rows.last.line.must_equal 2
+  end
+
+  it "it will give file path and line number" do
+    csv_path = fixture_file_path('persons.csv')
+    parser = CSV::AutoParser.new(csv_path) do |line_num, header_row| 
+      ["name", "Job title"].all? {|cell| header_row.include?(cell) } 
+    end
+    line_number = 1
+    parser.file_path.must_equal csv_path
+    parser.pre_header_rows.each do |row|
+      row.line_number.must_equal line_number
+      line_number += 1
+    end
+    table = parser.read
+    line_number = parser.header_line_number + 1
+    table.each do |row|
+      row.line_number.must_equal line_number
+      line_number += 1
+    end
   end
 
   it "will raise an exception if it can't find the header row" do
@@ -95,7 +112,12 @@ describe CSV::AutoParser do
   end
 
   it "should work just like CSV.new when not passed a block except that it can now take a file path as data too" do 
-    input_objects = [fixture_file_path('persons.csv'), File.open(fixture_file_path('persons.csv')), File.open(fixture_file_path('persons.csv'))]
+    input_objects = [
+      fixture_file_path('persons.csv'), 
+      File.open(fixture_file_path('persons.csv')), 
+      File.read(fixture_file_path('persons.csv')), 
+      StringIO.new(File.read(fixture_file_path('persons.csv')))
+    ]
     input_objects.each do |obj|
       parser = CSV::AutoParser.new(obj, header_converters: :symbol, headers: :first_row)
       parser.header_line_number.must_equal 1
@@ -105,14 +127,22 @@ describe CSV::AutoParser do
       table.first[:fullname].must_equal "bob"
       # method names are based off of converted header names!
       table.first.fullname.must_equal "bob"
+      if obj.is_a?(String) and File.exists?(obj)
+        parser.file_path.must_equal fixture_file_path('persons.csv')
+      else
+        parser.file_path.must_be_nil
+      end
+      table.first.line_number.must_equal 2
     end
     parser = CSV::AutoParser.new(fixture_file_path('persons.csv'), header_converters: :symbol, headers: "first_col,second_col,third_col,fourth_col")
     parser.header_line_number.must_equal nil
     parser.pre_header_rows.must_be_empty
+    parser.file_path.must_equal fixture_file_path('persons.csv')
     table = parser.read
     table.length.must_equal 6
     table[0].first_col.must_equal "full-name"
     table[1].first_col.must_equal "bob"
+    table[1].line_number.must_equal 2
   end
 
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: csv-autoparser
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ben Delsol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-21 00:00:00.000000000 Z
+date: 2014-06-17 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: minitest
   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: ''
@@ -44,7 +44,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -66,17 +66,17 @@ 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.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Can parse a CSV file automatically given a user specified header row.