csv-autoparser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dda3d9b42b637575933d1b307b5dd5f5687971c6
+  data.tar.gz: d28893032f72edf4824d4bed8d8c212cdab7a2d6
+SHA512:
+  metadata.gz: 93cb849bab22ab289d59a7e1821cad3b8fcdea073793d8a804fa19b71d60d07884e44d1a4696f0daadca083ff9c40d3eb862da7a60b0565cf7180cf418c4f236
+  data.tar.gz: 659990a336d41c984cc5468b9729d6f47cb5f78e2a018be348f65092a8a387c4455b384f0ca3fcfe7666c925fe25f4ec7f089c6b254055ea9eca14b1a6bae314

data/.gitignore

@@ -0,0 +1,18 @@
+.*.sw[opn]
+*.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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Benjamin Delsol
+
+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,28 @@
+# CSV::AutoParser
+
+CSV::AutoParser automatically parses a CSV file given a user specified header row.
+
+## Installation
+
+    $ gem install csv-autoparser
+
+## Usage
+
+    # ID header row by CSV line number.
+    csv = CSV::AutoParser.new("my_file.csv") {|csv_line_number, header_row| csv_line_number == 1 }
+    csv.rows.each {|row| puts row.full_name }
+
+    # -OR- ID header row by column header names.
+    csv = CSV::AutoParser.new(input_file) do |line_num, header_row| 
+      ["name", "Job title"].all? {|cell| header_row.include?(cell) } 
+    end
+    puts csv.rows.first.name # => "Jon Smith"
+    csv.rows.first.job_title # => "blacksmith"
+
+## Contributing
+
+1. Fork it ( http://github.com/bdiz/csv-autoparser/fork )
+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,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test_csv/*.rb']
+end
+
+task :default => :test

data/csv-autoparser.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csv/autoparser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv-autoparser"
+  spec.version       = CSV::AutoParser::VERSION
+  spec.authors       = ["Ben Delsol"]
+  spec.email         = [] # contact me via github (username: bdiz)
+  spec.summary       = %q{Can parse a CSV file automatically given a user specified header row.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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 "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/csv/autoparser.rb

@@ -0,0 +1,49 @@
+require "csv"
+require "csv/autoparser/version"
+
+class CSV
+  class AutoParser
+    class Row
+
+      def self.define_methods map
+        map.each_pair do |column_name, column_offset|
+          define_method(column_to_method_name(column_name)) { @row[column_offset] }
+        end
+      end
+
+      def self.column_to_method_name name
+        name.downcase.strip.gsub(/\s+/, '_').gsub(/-+/, '_').gsub(/[^\w]/, '')
+      end
+
+      def initialize row
+        @row = row
+      end
+    end
+
+    class HeaderRowNotFound < RuntimeError; end
+
+    attr_reader :pre_header_rows, :rows
+
+    def initialize file, &is_header
+      map = {}
+      csv_line_number = 0
+      @rows = []
+      @pre_header_rows = []
+      CSV.foreach(file) do |row| 
+        csv_line_number += 1
+        if map.empty?
+          if is_header.call(csv_line_number, row)
+            row.each_index {|index| map[row[index]] = index } 
+            Row.define_methods(map)
+          else
+            @pre_header_rows << row
+          end
+        else
+          @rows << Row.new(row)
+        end
+      end
+      raise HeaderRowNotFound, "Could not find header row in #{file}." if map.empty?
+    end
+
+  end
+end

data/lib/csv/autoparser/version.rb

@@ -0,0 +1,5 @@
+class CSV
+  class AutoParser
+    VERSION = "0.0.1"
+  end
+end

data/test/fixtures/persons.csv

@@ -0,0 +1,5 @@
+"full-name",job,"years of age"
+name,"Job title",age
+"Jon Smith",blacksmith, 55
+"Jimmy Johnson",farmer, 34
+"Kimmy Kimmson","pig wrangler", 29

data/test/minitest_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'csv/autoparser'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+
+def fixture_file_path file_name
+  File.join(File.expand_path('../fixtures', __FILE__), file_name)
+end
+

data/test/test_csv/autoparser.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift File.expand_path('../..', __FILE__)
+require 'minitest_helper'
+
+describe CSV::AutoParser do
+
+  def input_file 
+    fixture_file_path('persons.csv')
+  end
+
+  it "it can parse a csv automatically via csv line number id" do
+    csv = CSV::AutoParser.new(input_file) {|csv_line_number, header_row| csv_line_number == 1 }
+    csv.rows.length.must_equal 4
+    csv.rows.first.full_name.must_equal "name"
+  end
+
+  it "it can parse a csv automatically via header row id" do
+    csv = CSV::AutoParser.new(input_file) do |line_num, header_row| 
+      ["name", "Job title"].all? {|cell| header_row.include?(cell) } 
+    end
+    csv.rows.length.must_equal 3
+    csv.rows.first.name.must_equal "Jon Smith"
+    csv.rows.first.job_title.must_equal "blacksmith"
+    csv.rows.last.age.to_i.must_equal 29
+  end
+
+  it "will raise an exception if it can't find the header row" do
+    lambda { CSV::AutoParser.new(input_file) {|csv_line_number, header_row| csv_line_number == 0 }}.
+      must_raise(CSV::AutoParser::HeaderRowNotFound)
+  end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: csv-autoparser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Delsol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-24 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: ''
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE.txt
+- README.md
+- Rakefile
+- csv-autoparser.gemspec
+- lib/csv/autoparser.rb
+- lib/csv/autoparser/version.rb
+- test/fixtures/persons.csv
+- test/minitest_helper.rb
+- test/test_csv/autoparser.rb
+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.3
+signing_key: 
+specification_version: 4
+summary: Can parse a CSV file automatically given a user specified header row.
+test_files:
+- test/fixtures/persons.csv
+- test/minitest_helper.rb
+- test/test_csv/autoparser.rb